summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Moss <drkjam@gmail.com>2015-09-03 22:15:55 +0100
committerDavid Moss <drkjam@gmail.com>2015-09-03 22:15:55 +0100
commitc93a54355a10816f730b106e4561b4727de154f4 (patch)
treed7b980de1c83768e1b83fdce628facce9881ed43
parentc0317712a0e69fba4b11bfdd54309cf364272156 (diff)
downloadnetaddr-c93a54355a10816f730b106e4561b4727de154f4.tar.gz
- trimmed down README
-rw-r--r--README.md54
1 files changed, 7 insertions, 47 deletions
diff --git a/README.md b/README.md
index eed3411..8f3ad66 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
netaddr
=======
+A Python library for representing and manipulating network addresses.
+
[![Circle CI](https://circleci.com/gh/drkjam/netaddr.png?style=shield)](https://circleci.com/gh/drkjam/netaddr)
-[![Documentation Status](https://readthedocs.org/projects/netaddr/badge/?version=latest)](http://netaddr.readthedocs.org/en/latest/)
+[![Latest Version](https://img.shields.io/pypi/v/netaddr.svg)](pypi.python.org/pypi/netaddr)
[![PyPI Downloads](https://img.shields.io/pypi/dm/netaddr.svg)](pypi.python.org/pypi/netaddr)
-A Python library for representing and manipulating network addresses.
-
Provides support for:
Layer 3 addresses
@@ -26,53 +26,13 @@ Layer 2 addresses
- looking up IEEE organisational information (OUI, IAB)
- generating derived IPv6 addresses
-Changes
--------
-
-For details on the latest updates and changes, see :doc:`changes`
-
-License
--------
-
-This software is released under the liberal BSD license.
-
-See the :doc:`license` and :doc:`copyright` for full text.
-
-Dependencies
-------------
-
-- Python 2.5.x through 3.5.x
-- IPython (for netaddr interactive shell)
-
-Installation
+Requirements
------------
-
-See :doc:`installation` for details.
+[![Versions](https://img.shields.io/pypi/pyversions/netaddr.svg)](pypi.python.org/pypi/netaddr)
Documentation
-------------
-
-This library has comprehensive docstrings and a full set of project
-documentation (including tutorials):
-
-- http://pythonhosted.org/netaddr/
-- http://readthedocs.org/docs/netaddr/en/latest/
-
-Tests
------
-
-netaddr requires py.test (http://pytest.org/).
-
-To run the test suite, clone the repository and run:
-
- python setup.py test
-
-If any of the tests fail, *please* help the project's user base by filing
-bug reports on the netaddr issue tracker:
-
-- http://github.com/drkjam/netaddr/issues
-
-Finally...
-----------
+[![Documentation Status](https://readthedocs.org/projects/netaddr/badge/?version=latest)](http://netaddr.readthedocs.org/en/latest/) This library has comprehensive docstrings and a full set of project
+documentation (including tutorials).
Share and enjoy!