X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0677a539370b296399854e427ce7df2955ecfe57..cbf010e0a208ccef9a498e3276cdf79b23a01440:/README.md?ds=inline diff --git a/README.md b/README.md index 6efc7e9..536c6ee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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) +[![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) ![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. @@ -34,9 +34,16 @@ original. This slows it down. If you're feeling confident, use ``--fast``. +## Installation + +*Black* can be installed by running `pip install black`. It requires +Python 3.6.0+ to run but you can reformat Python 2 code with it, too. +*Black* is able to parse all of the new syntax supported on Python 3.6 +but also *effectively all* the Python 2 syntax at the same time. + + ## Usage -*Black* can be installed by running `pip install black`. ``` black [OPTIONS] [SRC]... @@ -262,27 +269,6 @@ Use the badge in your project's README.md: Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) - -## Tests - -Just run: - -``` -python setup.py test -``` - -## This tool requires Python 3.6.0+ to run - -But you can reformat Python 2 code with it, too. *Black* is able to parse -all of the new syntax supported on Python 3.6 but also *effectively all* -the Python 2 syntax at the same time. - -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](https://docs.python.org/3/library/pathlib.html) or -f-strings) instead of wasting cycles on Unicode compatibility, and so on. - - ## License MIT