diff --git a/README.md b/README.md index 7fba862..02cbe0e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [](https://deadcode.readthedocs.io/en/stable/) -
@@ -15,11 +15,22 @@ pip install deadcode
```
## Usage
+To see unused code findings:
```shell
deadcode .
```
-Or with command line options:
+To see suggested fixes:
+```shell
+deadcode . --fix --dry
+```
+
+To fix:
+```shell
+deadcode . --fix
+```
+
+Tune out some of the false positives, e.g.:
```
deadcode . --exclude=venv,tests --ignore-names=BaseTestCase,*Mixin --ignore-names-in-files=migrations
```