Add --check

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index c0870a8d748ccf49571f2c7ccfab3c4cda62b73a..ebff26a047a57e3e07ae15f212ac74999caeef01 100644 (file)
--- a/README.md
+++ b/README.md
@@ -43,6 +43,11 @@ black [OPTIONS] [SRC]...
 
 Options:
   -l, --line-length INTEGER   Where to wrap around.  [default: 88]
+  --check                     Don't write back the files, just return the
+                              status.  Return code 0 means nothing changed.
+                              Return code 1 means some files were reformatted.
+                              Return code 123 means there was an internal
+                              error.
   --fast / --safe             If --fast given, skip temporary sanity checks.
                               [default: --safe]
   --version                   Show the version and exit.
@@ -226,7 +231,7 @@ statements.
 
 By making the code exclusively Python 3.6+, I'm able to focus on the
 quality of the formatting and re-use all the nice features of the new
-releases (check out [pathlib](docs.python.org/3/library/pathlib.html) or
+releases (check out [pathlib](https://docs.python.org/3/library/pathlib.html) or
 f-strings) instead of wasting cycles on Unicode compatibility, and so on.
 
 
@@ -253,6 +258,8 @@ You can still try but prepare to be disappointed.
 
 ### 18.3a1
 
+* added `--check`
+
 * fixed invalid spacing of dots in relative imports (#6, #13)
 
 * fixed spurious space in parenthesized set expressions (#7)