Skip to content

Commit 6f5c4f6

Browse files
committed
Add description and usage to README
1 parent 935fdff commit 6f5c4f6

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
# AutoFormatter
22

3-
**TODO: Add description**
3+
This package have the responsibility to run `mix format`
4+
after **EVERY** commit to ensure that you modified code
5+
is formated.
46

57
## Installation
68

7-
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
8-
by adding `auto_formatter` to your list of dependencies in `mix.exs`:
9+
The best way to install this package is install it as a escript:
10+
11+
```bash
12+
mix escript.install hex auto_formatter
13+
```
14+
15+
Otherwise, this package can be installed by adding `auto_formatter` to
16+
your list of dependencies in `mix.exs`:
917

1018
```elixir
1119
def deps do
@@ -14,8 +22,17 @@ def deps do
1422
]
1523
end
1624
```
25+
Then, run `mix deps.get` on your terminal to download it.
26+
27+
## Usage
28+
29+
All that you need is init it:
30+
31+
```bash
32+
autoformatter init
33+
```
1734

18-
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
19-
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
20-
be found at [https://hexdocs.pm/auto_formatter](https://hexdocs.pm/auto_formatter).
35+
## Documentation
2136

37+
The docs can be found at
38+
[HexDocs](https://hexdocs.pm/auto_formatter).

0 commit comments

Comments
 (0)