Skip to content

Commit

Permalink
chore(Add Changelog): Add commits to changelog.
Browse files Browse the repository at this point in the history
Update readme and add changelog notes.
  • Loading branch information
ckoch-cars committed Jul 20, 2022
1 parent cea9bca commit 407f9aa
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 5 deletions.
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# v0.3.0

## Bug Fixes

* **Add and update tests.**
* update test ([23a7438d71250cad27dcb3c7db4f7c9ced883278](https://github.com/ckochx/ex_factor/commit/23a7438d71250cad27dcb3c7db4f7c9ced883278))
* **ExFactor.Extractor**
* create path! for new modules ([04d16d93f86432e28faeb492445fc16f240553b7](https://github.com/ckochx/ex_factor/commit/04d16d93f86432e28faeb492445fc16f240553b7))

## Breaking Changes

* **BREAKING CHANGE**
* update min elixir version ([61b6b5759dbd82cb3150324e5f160f60d2b12974](https://github.com/ckochx/ex_factor/commit/61b6b5759dbd82cb3150324e5f160f60d2b12974))

# v0.2.0 (2022-05-01)
WIP release

# v0.1.0 (2022-01-01)
Initial release
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ Use at your peril, _for now._
- [X] github actions, run test suite
- [X] Add Mix.Task tests
- [X] Add CLI tests
- [X] Add and configure CHANGELOG tracking.

## Roadmap TODO

- [] Add and configure CHANGELOG tracking.
- [] Add test for one file containing more than one `defmodule`
- [] How does this work with macro code? Does that even make sense as a case to handle?
- [] Update .exs files too?
Expand All @@ -40,9 +40,19 @@ Use at your peril, _for now._
- [] ElixirLS integration for VSCode?
- [] Write the module code to rename usages of the refactored function

## Updates

See [CHANGELOG.md](https://github.com/ckochx/ex_factor/blob/main/CHANGELOG.md)

Using [changex](https://github.com/Gazler/changex) to track changes.

### changex usage:

`mix changex.update --github ckochx/ex_factor`

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
[Hex](https://hex.pm/docs/publish), the package can be installed
by adding `ex_factor` to your list of dependencies in `mix.exs`:

```elixir
Expand All @@ -53,9 +63,12 @@ def deps do
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
Documentation is published on [HexDocs](https://hexdocs.pm). The docs can
be found at [https://hexdocs.pm/ex_factor](https://hexdocs.pm/ex_factor).

Alternate name:
REFACTORY, just in case.
REFACTORY, just in case.

## License

See [LICENSE](https://github.com/ckochx/ex_factor/blob/main/LICENSE)

0 comments on commit 407f9aa

Please sign in to comment.