X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/42519f8b320103d903d880b4e0733bc3b08fe015..5c6a0dd03f7f6d8694d1b9a62f9770be44f0b809:/README.md diff --git a/README.md b/README.md index c5166b8..d74d436 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,16 @@ -# black +![Black Logo](https://raw.githubusercontent.com/ambv/black/master/docs/_static/logo2-readme.png) +

The Uncompromising Code Formatter

-[![Build Status](https://travis-ci.org/ambv/black.svg?branch=master)](https://travis-ci.org/ambv/black) [![Documentation Status](http://readthedocs.org/projects/black/badge/?version=latest)](http://black.readthedocs.io/en/latest/?badge=latest) [![Coverage Status](https://coveralls.io/repos/github/ambv/black/badge.svg?branch=master)](https://coveralls.io/github/ambv/black?branch=master) ![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) +

+Build Status +Documentation Status +Coverage Status +License: MIT +PyPI +Code style: black +

-> Any color you like. +> “Any color you like.” *Black* is the uncompromising Python code formatter. By using it, you @@ -61,7 +69,7 @@ Options: --help Show this message and exit. ``` -`Black` is a well-behaved Unix-style command-line tool: +*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; @@ -223,6 +231,7 @@ body. ### Editor integration * Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode) +* Emacs: [proofit404/blacken](https://github.com/proofit404/blacken) 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)). @@ -230,9 +239,8 @@ 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. +Vim and Atom/Nuclide integration is planned by the author, others will +require external contributions. Patches welcome! ✨ 🍰 ✨ @@ -292,7 +300,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log -### 18.3a4 (unreleased) +### 18.3a4 * `# fmt: off` and `# fmt: on` are implemented (#5)