From 088559eedd40b16fff2ce97e48006580be39dd03 Mon Sep 17 00:00:00 2001 From: Akshay Date: Sat, 2 Oct 2021 10:52:22 +0530 Subject: update docs; nix-analyzer -> statix --- readme.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 9a9e0ca..76c633a 100644 --- a/readme.md +++ b/readme.md @@ -1,15 +1,15 @@ -## nix-analyzer +## statix -`nix-analyzer` intends to be a static analysis tool for the +`statix` intends to be a static analysis tool for the Nix programming language. -For the time-being, `nix-analyzer` works only with ASTs +For the time-being, `statix` works only with ASTs produced by the `rnix-parser` crate and does not evaluate -any nix code. +any nix code (imports, attr sets etc.). ## Architecture -`nix-analyzer` has the following components: +`statix` has the following components: - `bin`: the CLI/entrypoint - `lib`: library of lints and utilities to define these @@ -18,7 +18,7 @@ any nix code. ### `bin` -This is the main point of interaction between `nix-analyzer` +This is the main point of interaction between `statix` and the end user. It's output is human-readable and should also support JSON/errorfmt outputs for external tools to use. -- cgit v1.2.3