chore: document the new option

gforcada · Oct 8, 2022 · 204f348 · 204f348
1 parent 81307ec
commit 204f348
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -73,6 +73,14 @@ Install with pip::
 
     $ pip install flake8-builtins
 
+Options
+-------
+
+One can use `--builtins-ignorelist` option, or configuration option,
+to ignore a custom list of builtins::
+
+    $ flake8 --builtins-ignorelist id,copyright *.py
+
 Requirements
 ------------
 - Python 3.7, 3.8, 3.9