aboutsummaryrefslogtreecommitdiffstats
path: root/README.mkd
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2015-06-18 11:37:04 +0200
committerMaximilian Hils <git@maximilianhils.com>2015-06-18 11:37:04 +0200
commit3e282d764e5ad37d54b609dfac4d50527d64dd79 (patch)
tree786726c85bb59990b25e48452357d6007718ae0f /README.mkd
parent014b76bff7b9af0a9ff3704be49aa84232c7fa3e (diff)
parent6a4dcaf3561cf279937114a8a80ebad8adcc1eec (diff)
downloadmitmproxy-3e282d764e5ad37d54b609dfac4d50527d64dd79.tar.gz
mitmproxy-3e282d764e5ad37d54b609dfac4d50527d64dd79.tar.bz2
mitmproxy-3e282d764e5ad37d54b609dfac4d50527d64dd79.zip
Merge branch 'master' of github.com:mitmproxy/netlib
Diffstat (limited to 'README.mkd')
-rw-r--r--README.mkd20
1 files changed, 13 insertions, 7 deletions
diff --git a/README.mkd b/README.mkd
index 79e7f803..f5e66d99 100644
--- a/README.mkd
+++ b/README.mkd
@@ -1,8 +1,9 @@
-[![Build Status](https://travis-ci.org/mitmproxy/netlib.svg?branch=master)](https://travis-ci.org/mitmproxy/netlib)
-[![Coverage Status](https://coveralls.io/repos/mitmproxy/netlib/badge.svg?branch=master)](https://coveralls.io/r/mitmproxy/netlib)
-[![Latest Version](https://pypip.in/version/netlib/badge.svg?style=flat)](https://pypi.python.org/pypi/netlib)
-[![Supported Python versions](https://pypip.in/py_versions/netlib/badge.svg?style=flat)](https://pypi.python.org/pypi/netlib)
-[![Supported Python implementations](https://pypip.in/implementation/netlib/badge.svg?style=flat)](https://pypi.python.org/pypi/netlib)
+[![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
@@ -14,5 +15,10 @@ functions, and are designed to allow misbehaviour when needed.
Requirements
------------
-* [Python](http://www.python.org) 2.7.x.
-* Third-party packages listed in [setup.py](https://github.com/mitmproxy/netlib/blob/master/setup.py) \ No newline at end of file
+* [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).