Skip to content

Commit

Permalink
Add more information to README
Browse files Browse the repository at this point in the history
  • Loading branch information
weavejester committed May 29, 2023
1 parent 4c45c73 commit 47c0023
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Linux or MacOS, you can run the following command to install the binary into
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/weavejester/cljfmt/HEAD/install.sh)"
```

You can also run this command to update cljfmt to the latest version.

If you're using Windows, there's a [zipped up binary][] you can download and
extract manually.

Expand All @@ -48,7 +50,12 @@ And to fix those errors:
cljfmt fix
```

Use `--help` for a list of all the command-line options.

For persistent configuration, you can use a [configuration file][].

[zipped up binary]: https://github.com/weavejester/cljfmt/releases/download/0.10.2/cljfmt-0.10.2-win-amd64.zip
[configuration file]: #configuration

### Clojure Tools

Expand Down Expand Up @@ -94,7 +101,11 @@ And to fix those errors:
lein cljfmt fix
```

To configure it, put a `:cljfmt` key and a map of options in your
project file. See the [configuration][] section for more details.

[leiningen]: https://github.com/technomancy/leiningen
[configuration]: #configuration

### Library

Expand Down Expand Up @@ -217,6 +228,9 @@ project map:
Leiningen where the `:source-paths` and `:test-paths` keys are used
instead.

Paths can also be passed as command line arguments. If the path is
`-`, then the input is STDIN, and the output STDOUT.

## License

Copyright © 2023 James Reeves
Expand Down

0 comments on commit 47c0023

Please sign in to comment.