Skip to content
Browse files

Separate PyPi README from Sphinx index

  • Loading branch information...
1 parent 32550f0 commit fcff40d505b99341e73afaf51fdc26da42e61bb5 @tiwilliam tiwilliam committed
Showing with 45 additions and 16 deletions.
  1. +0 −15 README.rst
  2. +0 −1 docs/index.rst
  3. +45 −0 docs/index.rst
View
15 README.rst
@@ -5,8 +5,6 @@ This library is based on `Maxmind's GeoIP C API <https://github.com/maxmind/geoi
Tested with Python version 2.6, 2.7, 3.2 and 3.3.
-|Build Status| |Coverage Status| |Downloads|
-
Installation
------------
@@ -28,18 +26,5 @@ and code submission.
Documentation
-------------
-.. toctree::
- :maxdepth: 1
-
- getting-started
- supported-databases
- api-reference
-
For more information, `check out the documentation <http://pygeoip.readthedocs.org/>`__ over at Read the Docs.
-.. |Build Status| image:: https://api.travis-ci.org/appliedsec/pygeoip.png?branch=master
- :target: https://travis-ci.org/appliedsec/pygeoip
-.. |Coverage Status| image:: https://coveralls.io/repos/appliedsec/pygeoip/badge.png
- :target: https://coveralls.io/r/appliedsec/pygeoip
-.. |Downloads| image:: https://pypip.in/d/pygeoip/badge.png
- :target: https://crate.io/packages/pygeoip
View
1 docs/index.rst
View
45 docs/index.rst
@@ -0,0 +1,45 @@
+Pure Python GeoIP API
+=====================
+
+This library is based on `Maxmind's GeoIP C API <https://github.com/maxmind/geoip-api-c>`__.
+
+Tested with Python version 2.6, 2.7, 3.2 and 3.3.
+
+|Build Status| |Coverage Status| |Downloads|
+
+Installation
+------------
+
+You can easily install pygeoip from PyPi.
+
+.. code:: python
+
+ pip install pygeoip
+
+Issues and Contribution
+-----------------------
+
+Bug reports are done by `creating an issue on
+Github <https://github.com/appliedsec/pygeoip/issues>`__. If you want to
+contribute you can always `create a pull
+request <https://github.com/appliedsec/pygeoip/pulls>`__ for discussion
+and code submission.
+
+Documentation
+-------------
+
+.. toctree::
+ :maxdepth: 1
+
+ getting-started
+ supported-databases
+ api-reference
+
+For more information, `check out the documentation <http://pygeoip.readthedocs.org/>`__ over at Read the Docs.
+
+.. |Build Status| image:: https://api.travis-ci.org/appliedsec/pygeoip.png?branch=master
+ :target: https://travis-ci.org/appliedsec/pygeoip
+.. |Coverage Status| image:: https://coveralls.io/repos/appliedsec/pygeoip/badge.png
+ :target: https://coveralls.io/r/appliedsec/pygeoip
+.. |Downloads| image:: https://pypip.in/d/pygeoip/badge.png
+ :target: https://crate.io/packages/pygeoip

0 comments on commit fcff40d

Please sign in to comment.
Something went wrong with that request. Please try again.