Skip to content

Commit 1838576

Browse files
committed
Add separate README for Github
1 parent fcff40d commit 1838576

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Pure Python GeoIP API
2+
3+
This library is based on [Maxmind's GeoIP C API](https://github.com/maxmind/geoip-api-c).
4+
5+
Tested with Python version 2.6, 2.7, 3.2 and 3.3.
6+
7+
[![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)
8+
9+
## Installation
10+
11+
You can easily install pygeoip from PyPi.
12+
13+
```bash
14+
pip install pygeoip
15+
```
16+
17+
## Issues and Contribution
18+
19+
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.
20+
21+
## Documentation
22+
23+
For more information, [check out the documentation](http://pygeoip.readthedocs.org) over at Read the Docs.

0 commit comments

Comments
 (0)