Pin attrs to >=17.4.0 for @dataclass use

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index b5ebfa005452fcac322c0844b9e35211f8c014b7..20ab4be7e5b3c728d8cf6863563ac34e3d4fd22a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -54,6 +54,12 @@ Options:
   --help                      Show this message and exit.
 ```
 
   --help                      Show this message and exit.
 ```
 

+`Black` is a well-behaved Unix-style command-line tool:
+* it does nothing if no sources are passed to it;
+* it will read from standard input and write to standard output if `-`
+  is used as the filename;
+* it only outputs messages to users on standard error.
+

 
 ## The philosophy behind *Black*
 
 
 ## The philosophy behind *Black*
 


@@ -209,6 +215,12 @@ body.
 
 * Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode)
 
 
 * Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode)
 

+Any tool that can pipe code through *Black* using its stdio mode (just
+[use `-` as the file name](http://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
+The formatted code will be returned on stdout (unless `--check` was
+passed).  *Black* will still emit messages on stderr but that shouldn't
+affect your use case.
+

 There is currently no integration with any other text editors. Vim and
 Atom/Nuclide integration is planned by the author, others will require
 external contributions.
 There is currently no integration with any other text editors. Vim and
 Atom/Nuclide integration is planned by the author, others will require
 external contributions.