Mention delimiter_split() in CannotSplit docstring

[etc/vim.git] / README.md

diff --git a/README.md b/README.md
index b5ebfa005452fcac322c0844b9e35211f8c014b7..6ec8dd8d79de45dfe6acb38e6489b86054aa90e8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # black
 
 # black
 

-[![Build Status](https://travis-ci.org/ambv/black.svg?branch=master)](https://travis-ci.org/ambv/black)
+[![Build Status](https://travis-ci.org/ambv/black.svg?branch=master)](https://travis-ci.org/ambv/black) ![License: MIT](https://img.shields.io/github/license/ambv/black.svg) ![PyPI](https://img.shields.io/pypi/v/black.svg) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

 
 > Any color you like.
 
 
 > Any color you like.
 


@@ -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.


@@ -237,6 +249,18 @@ and [`pipenv`](https://docs.pipenv.org/):
 > This vastly improves the formatting of our code. Thanks a ton!
 
 
 > This vastly improves the formatting of our code. Thanks a ton!
 
 

+## Show your style
+
+Use the badge in your project's README.md:
+
+```markdown
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+```
+
+Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+
+
+

 ## Tests
 
 Just run:
 ## Tests
 
 Just run:


@@ -281,6 +305,17 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Change Log
 
 
 ## Change Log
 

+### 18.3a4 (unreleased)
+
+* don't remove single trailing commas from square bracket indexing
+  (#59)
+
+* don't omit whitespace if the previous factor leaf wasn't a math
+  operator (#55)
+
+* omit extra space in kwarg unpacking if it's the first argument (#46)
+
+

 ### 18.3a3
 
 * don't remove single empty lines outside of bracketed expressions
 ### 18.3a3
 
 * don't remove single empty lines outside of bracketed expressions