From ade09b4d172ff649b716a05ce597d2da864a3623 Mon Sep 17 00:00:00 2001
From: Akshay <nerdy@peppe.rs>
Date: Sun, 30 Jan 2022 12:39:38 +0530
Subject: rework docs and readme

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

(limited to 'readme.md')

diff --git a/readme.md b/readme.md
index 1cdadb5..e60d38d 100644
--- a/readme.md
+++ b/readme.md
@@ -48,6 +48,12 @@ nix run git+https://git.peppe.rs/languages/statix -- --help
 cachix use statix
 ```
 
+Install from nixpkgs:
+
+```shell
+nix run nixpkgs#statix -- help
+```
+
 Install with [brew/linuxbrew](https://brew.sh)
 
 ```bash
@@ -130,45 +136,15 @@ empty_pattern
 redundant_pattern_bind
 unquoted_uri
 deprecated_is_null
+empty_inherit
+faster_groupby
+faster_zipattrswith
+deprecated_to_path
 ```
 
 All lints are enabled by default.
 
-## Architecture
-
-`statix` has the following components:
-
-- `bin`: the CLI/entrypoint
-- `lib`: library of lints and utilities to define these
-  lints
-- `vfs`: virtual filesystem
-- `macros`: procedural macros to help define a lint
-
-### `bin`
-
-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.
-
-### `lib`
-
-A library of AST-based lints and utilities to help write
-those lints. It should be easy for newcomers to write lints
-without being familiar with the rest of the codebase.
-
-### `vfs`
-
-VFS is an in-memory filesystem. It provides cheap-to-copy
-handles (`FileId`s) to access paths and file contents.
-
-### `macros`
-
-This crate intends to be a helper layer to declare lints and
-their metadata.
-
 ## TODO
 
-- Test suite for lints and suggestions
 - Resolve imports and scopes for better lints
 - Add silent flag that exits with status
-- 
cgit v1.2.3