rework cli, fix is now a flag, implement dry-run mode

1 files changed, 45 insertions, 4 deletions

diff --git a/readme.md b/readme.md
index 9ccb66e..68265cc 100644
--- a/readme.md
+++ b/readme.md
@@ -1,12 +1,53 @@
-## statix
+# statix
 
-`statix` intends to be a static analysis tool for the
-Nix programming language.
+> Lints and suggestions for the Nix programming language.
+
+`statix` highlights antipatterns in Nix code. `statix fix`
+can fix several such occurrences.
 
 For the time-being, `statix` works only with ASTs
 produced by the `rnix-parser` crate and does not evaluate
 any nix code (imports, attr sets etc.). 
 
+## Installation
+
+`statix` is available via a nix flake:
+
+```
+nix run git+https://git.peppe.rs/languages/statix
+
+# or
+
+nix build git+https://git.peppe.rs/languages/statix
+./result/bin/statix --help
+```
+
+## Usage
+
+```
+statix 0.1.0
+
+Akshay <[email protected]>
+
+Lints and suggestions for the Nix programming language
+
+USAGE:
+    statix [FLAGS] [OPTIONS] [--] [TARGET]
+
+ARGS:
+    <TARGET>    File or directory to run statix on [default: .]
+
+FLAGS:
+    -d, --dry-run    Do not fix files in place, display a diff instead
+    -f, --fix        Find and fix issues raised by statix
+    -h, --help       Print help information
+    -V, --version    Print version information
+
+OPTIONS:
+    -i, --ignore <IGNORE>...    Globs of file patterns to skip
+    -o, --format <FORMAT>       Output format. Supported values: errfmt, json (on feature flag only)
+```
+
 ## Architecture
 
 `statix` has the following components:
@@ -37,5 +78,5 @@ their metadata.
 ## TODO
 
 - Offline documentation for each lint
-- Automatically fix all lints from suggestions generated
 - Test suite for lints and suggestions
+- Output singleline/errfmt + vim plugin