From 20d195988de1014517ff1a1c8c1041cff5f88e05 Mon Sep 17 00:00:00 2001
From: Akshay <nerdy@peppe.rs>
Date: Tue, 26 Oct 2021 19:18:28 +0530
Subject: set internal crates to 0.0.0, bump to v0.2.0

---
 readme.md | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 293b72e..d1eda39 100644
--- a/readme.md
+++ b/readme.md
@@ -2,8 +2,8 @@
 
 > Lints and suggestions for the Nix programming language.
 
-`statix` highlights antipatterns in Nix code. `statix --fix`
-can fix several such occurrences.
+`statix check` 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
@@ -12,7 +12,7 @@ any nix code (imports, attr sets etc.).
 ## Examples
 
 ```shell
-$ statix tests/c.nix
+$ statix check tests/c.nix
 [W04] Warning: Assignment instead of inherit from
    ╭─[tests/c.nix:2:3]
    │
@@ -21,7 +21,7 @@ $ statix tests/c.nix
    ·                  ╰───────────────── This assignment is better written with inherit
 ───╯
 
-$ statix --fix --dry-run tests/c.nix
+$ statix fix --dry-run tests/c.nix
 --- tests/c.nix
 +++ tests/c.nix [fixed]
 @@ -1,6 +1,6 @@
@@ -54,10 +54,10 @@ Basic usage is as simple as:
 
 ```shell
 # recursively finds nix files and raises lints
-statix /path/to/dir
+statix check /path/to/dir
 
 # ignore generated files, such as Cargo.nix
-statix /path/to/dir -i '*Cargo.nix'
+statix check /path/to/dir -i '*Cargo.nix'
 
 # see `statix -h` for a full list of options
 ```
@@ -66,18 +66,18 @@ Certain lints have suggestions. Apply suggestions back to
 the source with:
 
 ```shell
-statix --fix /path/to/file
+statix fix /path/to/file
 
 # show diff, do not write to file
-statix --fix --dry-run /path/to/file
+statix fix --dry-run /path/to/file
 ```
 
 `statix` supports a variety of output formats; standard,
 json and errfmt:
 
 ```shell
-statix /path/to/dir -o json
-statix /path/to/dir -o errfmt # singleline, easy to integrate with vim
+statix check /path/to/dir -o json   # only when compiled with --all-features
+statix check /path/to/dir -o errfmt # singleline, easy to integrate with vim
 ```
 
 ## Architecture
-- 
cgit v1.2.3