aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorAkshay <[email protected]>2021-10-02 06:22:22 +0100
committerAkshay <[email protected]>2021-10-02 09:09:39 +0100
commit088559eedd40b16fff2ce97e48006580be39dd03 (patch)
tree46bb0ec90175d324e6b63d80f104e5ff9f42cea6 /readme.md
parenta60429891fe9eb5290f95a52dd5e56f62d25d344 (diff)
update docs; nix-analyzer -> statix
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/readme.md b/readme.md
index 9a9e0ca..76c633a 100644
--- a/readme.md
+++ b/readme.md
@@ -1,15 +1,15 @@
1## nix-analyzer 1## statix
2 2
3`nix-analyzer` intends to be a static analysis tool for the 3`statix` intends to be a static analysis tool for the
4Nix programming language. 4Nix programming language.
5 5
6For the time-being, `nix-analyzer` works only with ASTs 6For the time-being, `statix` works only with ASTs
7produced by the `rnix-parser` crate and does not evaluate 7produced by the `rnix-parser` crate and does not evaluate
8any nix code. 8any nix code (imports, attr sets etc.).
9 9
10## Architecture 10## Architecture
11 11
12`nix-analyzer` has the following components: 12`statix` has the following components:
13 13
14- `bin`: the CLI/entrypoint 14- `bin`: the CLI/entrypoint
15- `lib`: library of lints and utilities to define these 15- `lib`: library of lints and utilities to define these
@@ -18,7 +18,7 @@ any nix code.
18 18
19### `bin` 19### `bin`
20 20
21This is the main point of interaction between `nix-analyzer` 21This is the main point of interaction between `statix`
22and the end user. It's output is human-readable and should 22and the end user. It's output is human-readable and should
23also support JSON/errorfmt outputs for external tools to 23also support JSON/errorfmt outputs for external tools to
24use. 24use.