aboutsummaryrefslogtreecommitdiffstats
path: root/README.mkd
diff options
context:
space:
mode:
authorMaximilian Hils <git@maximilianhils.com>2013-12-13 15:09:42 +0100
committerMaximilian Hils <git@maximilianhils.com>2013-12-13 15:09:42 +0100
commit9ea4646262d855b1564cbf78e7bf9ab0be332dfd (patch)
tree9dcb5ec5b729e61d8eaee8f68b85997a4817c872 /README.mkd
parentf2e8efdf15a5f6bc3636eaf00b280c8ad6fda37b (diff)
downloadmitmproxy-9ea4646262d855b1564cbf78e7bf9ab0be332dfd.tar.gz
mitmproxy-9ea4646262d855b1564cbf78e7bf9ab0be332dfd.tar.bz2
mitmproxy-9ea4646262d855b1564cbf78e7bf9ab0be332dfd.zip
use markdown for readme
Diffstat (limited to 'README.mkd')
-rw-r--r--README.mkd8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.mkd b/README.mkd
new file mode 100644
index 00000000..f3516faf
--- /dev/null
+++ b/README.mkd
@@ -0,0 +1,8 @@
+[![Build Status](https://travis-ci.org/mitmproxy/netlib.png)](https://travis-ci.org/mitmproxy/netlib) [![Coverage Status](https://coveralls.io/repos/mitmproxy/netlib/badge.png)](https://coveralls.io/r/mitmproxy/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.
+