summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorFlorent Xicluna <florent.xicluna@gmail.com>2013-01-25 01:52:29 +0100
committerFlorent Xicluna <florent.xicluna@gmail.com>2013-01-25 01:52:29 +0100
commit5fd511edfb6b9d67c93519cb0772f8eaea138b0f (patch)
treedd981aa33dc5962c9d1bb77824e3df50e5409ece /README.rst
parent1df0995968f0cf8fcb6b94088723e2753f92f701 (diff)
downloadpyflakes-5fd511edfb6b9d67c93519cb0772f8eaea138b0f.tar.gz
Add a basic README.rst file
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..5316a7c
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,21 @@
+========
+Pyflakes
+========
+
+A simple program which checks Python source files for errors.
+
+It is `available on PyPI <http://pypi.python.org/pypi/pyflakes>`_
+and it supports all active versions of Python from 2.5 to 2.7.
+
+
+Installation
+------------
+
+It can be installed with::
+
+ $ pip install --upgrade pyflakes
+
+
+.. image:: https://api.travis-ci.org/pyflakes/pyflakes.png
+ :target: https://travis-ci.org/pyflakes/pyflakes
+ :alt: Build status