summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorDmitry Tokarev <dmitrytokarev@users.noreply.github.com>2017-06-19 22:55:08 -0700
committerBenjamin Peterson <benjamin@python.org>2017-06-19 22:55:08 -0700
commit7036f12f9764f272fb7bbdad509f1051134b952d (patch)
treec3921df9dfc793e1980175e2de738d6419cd89f1 /README.rst
parentf574c7be6ebc80041ef58ca29588f310248ebed4 (diff)
downloadsix-git-7036f12f9764f272fb7bbdad509f1051134b952d.tar.gz
add badges to readme (#200)
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..84e6a50
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,25 @@
+.. image:: http://img.shields.io/pypi/v/six.svg
+ :target: https://pypi.python.org/pypi/six
+
+.. image:: https://travis-ci.org/benjaminp/six.svg?branch=master
+ :target: https://travis-ci.org/benjaminp/six
+
+.. image:: http://img.shields.io/badge/license-MIT-green.svg
+ :target: https://github.com/benjaminp/six/blob/master/LICENSE
+
+Six is a Python 2 and 3 compatibility library. It provides utility functions
+for smoothing over the differences between the Python versions with the goal of
+writing Python code that is compatible on both Python versions. See the
+documentation for more information on what is provided.
+
+Six supports every Python version since 2.6. It is contained in only one Python
+file, so it can be easily copied into your project. (The copyright and license
+notice must be retained.)
+
+Online documentation is at https://pythonhosted.org/six/.
+
+Bugs can be reported to https://github.com/benjaminp/six. The code can also
+be found there.
+
+For questions about six or porting in general, email the python-porting mailing
+list: https://mail.python.org/mailman/listinfo/python-porting