Skip to content

Commit 67083f1

Browse files
committed
Update incorrect comment in readme
It currently doesn't lint only the files that have changed. I need to figure out all the git ls-file/ls-tree stuff properly.
1 parent 41d9cfc commit 67083f1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ This is similar to pre-commit. Create a `.nit.json5` file (`.jsonc` and `.json`
5252
}
5353
```
5454

55-
Then run `nit run --all` in the root of your repository. It will lint all the files in the repository. If you run `nit run` instead it will only lint the files that have changed, as determined by `git diff`.
55+
Then run `nit run --all` in the root of your repository. It will lint all the files in the repository. If you run `nit run` instead it will only lint staged files.
5656

5757
To install as a git hook, run `nit install`. For compatibility with `pre-commit` this will install as a pre-commit hook by default, though I find pre-push way less annoying so I would recommend `nit install --hook-type pre-push` instead.
5858

0 commit comments

Comments
 (0)