aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2015-11-29 19:04:19 +0100
committerMaximilian Hils <git@maximilianhils.com>2015-11-29 19:04:19 +0100
commit7cb57e206fe148d544f5167a35bd02eadeca495f (patch)
treea7a11f7986b26e067db1922703ec14ed77eefb22
parent4d17ddba381cf42e2b5ca2c7aade527d11989964 (diff)
downloadmitmproxy-7cb57e206fe148d544f5167a35bd02eadeca495f.tar.gz
mitmproxy-7cb57e206fe148d544f5167a35bd02eadeca495f.tar.bz2
mitmproxy-7cb57e206fe148d544f5167a35bd02eadeca495f.zip
README: mkd -> rst
pypi only renders reStructuredText.
-rw-r--r--MANIFEST.in4
-rw-r--r--README.mkd24
-rw-r--r--README.rst35
-rw-r--r--setup.py2
4 files changed, 38 insertions, 27 deletions
diff --git a/MANIFEST.in b/MANIFEST.in
index bd59f003..a68c043e 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,3 @@
-include LICENSE README.mkd
-recursive-include test *
+include LICENSE CONTRIBUTORS README.rst
+graft test
recursive-exclude * *.pyc *.pyo *.swo *.swp \ No newline at end of file
diff --git a/README.mkd b/README.mkd
deleted file mode 100644
index f5e66d99..00000000
--- a/README.mkd
+++ /dev/null
@@ -1,24 +0,0 @@
-[![Build Status](https://img.shields.io/travis/mitmproxy/netlib/master.svg)](https://travis-ci.org/mitmproxy/netlib)
-[![Code Health](https://landscape.io/github/mitmproxy/netlib/master/landscape.svg?style=flat)](https://landscape.io/github/mitmproxy/netlib/master)
-[![Coverage Status](https://img.shields.io/coveralls/mitmproxy/netlib/master.svg)](https://coveralls.io/r/mitmproxy/netlib)
-[![Downloads](https://img.shields.io/pypi/dm/netlib.svg?color=orange)](https://pypi.python.org/pypi/netlib)
-[![Latest Version](https://img.shields.io/pypi/v/netlib.svg)](https://pypi.python.org/pypi/netlib)
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/netlib.svg)](https://pypi.python.org/pypi/netlib)
-
-Netlib is a collection of network utility classes, used by the pathod and
-mitmproxy projects. It differs from other projects in some fundamental
-respects, because both pathod and mitmproxy often need to violate standards.
-This means that protocols are implemented as small, well-contained and flexible
-functions, and are designed to allow misbehaviour when needed.
-
-
-Requirements
-------------
-
-* [Python](http://www.python.org) 2.7.x or a compatible version of pypy.
-* Third-party packages listed in [setup.py](https://github.com/mitmproxy/netlib/blob/master/setup.py)
-
-Hacking
--------
-
-If you'd like to work on netlib, check out the instructions in mitmproxy's [README](https://github.com/mitmproxy/mitmproxy#hacking).
diff --git a/README.rst b/README.rst
new file mode 100644
index 00000000..694e3ad9
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,35 @@
+|travis| |coveralls| |downloads| |latest-release| |python-versions|
+
+Netlib is a collection of network utility classes, used by the pathod and
+mitmproxy projects. It differs from other projects in some fundamental
+respects, because both pathod and mitmproxy often need to violate standards.
+This means that protocols are implemented as small, well-contained and flexible
+functions, and are designed to allow misbehaviour when needed.
+
+
+Hacking
+-------
+
+If you'd like to work on netlib, check out the instructions in mitmproxy's README_.
+
+.. |travis| image:: https://img.shields.io/travis/mitmproxy/netlib/master.svg
+ :target: https://travis-ci.org/mitmproxy/netlib
+ :alt: Build Status
+
+.. |coveralls| image:: https://img.shields.io/coveralls/mitmproxy/netlib/master.svg
+ :target: https://coveralls.io/r/mitmproxy/netlib
+ :alt: Coverage Status
+
+.. |downloads| image:: https://img.shields.io/pypi/dm/netlib.svg?color=orange
+ :target: https://pypi.python.org/pypi/netlib
+ :alt: Downloads
+
+.. |latest-release| image:: https://img.shields.io/pypi/v/netlib.svg
+ :target: https://pypi.python.org/pypi/netlib
+ :alt: Latest Version
+
+.. |python-versions| image:: https://img.shields.io/pypi/pyversions/netlib.svg
+ :target: https://pypi.python.org/pypi/netlib
+ :alt: Supported Python versions
+
+.. _README: https://github.com/mitmproxy/mitmproxy#hacking \ No newline at end of file
diff --git a/setup.py b/setup.py
index 1bfab2ba..c4bbb8cf 100644
--- a/setup.py
+++ b/setup.py
@@ -11,7 +11,7 @@ from netlib import version
here = os.path.abspath(os.path.dirname(__file__))
-with open(os.path.join(here, 'README.mkd'), encoding='utf-8') as f:
+with open(os.path.join(here, 'README.rst'), encoding='utf-8') as f:
long_description = f.read()
deps = {