Add separate README for Github

StdCarrot · Feb 11, 2014 · 1838576 · 1838576
1 parent fcff40d
commit 1838576
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# 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](https://api.travis-ci.org/appliedsec/pygeoip.png?branch=master)](https://travis-ci.org/appliedsec/pygeoip) [![Coverage Status](https://coveralls.io/repos/appliedsec/pygeoip/badge.png)](https://coveralls.io/r/appliedsec/pygeoip) [![Downloads](https://pypip.in/d/pygeoip/badge.png)](https://crate.io/packages/pygeoip)
+
+## Installation
+
+You can easily install pygeoip from PyPi.
+
+```bash
+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
+
+For more information, [check out the documentation](http://pygeoip.readthedocs.org) over at Read the Docs.