39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
# MaxMind DB Reader for Go #
|
|
|
|
[![Build Status](https://travis-ci.org/oschwald/maxminddb-golang.png?branch=master)](https://travis-ci.org/oschwald/maxminddb-golang)
|
|
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/4j2f9oep8nnfrmov/branch/master?svg=true)](https://ci.appveyor.com/project/oschwald/maxminddb-golang/branch/master)
|
|
[![GoDoc](https://godoc.org/github.com/oschwald/maxminddb-golang?status.png)](https://godoc.org/github.com/oschwald/maxminddb-golang)
|
|
|
|
This is a Go reader for the MaxMind DB format. Although this can be used to
|
|
read [GeoLite2](http://dev.maxmind.com/geoip/geoip2/geolite2/) and
|
|
[GeoIP2](https://www.maxmind.com/en/geoip2-databases) databases,
|
|
[geoip2](https://github.com/oschwald/geoip2-golang) provides a higher-level
|
|
API for doing so.
|
|
|
|
This is not an official MaxMind API.
|
|
|
|
## Installation ##
|
|
|
|
```
|
|
go get github.com/oschwald/maxminddb-golang
|
|
```
|
|
|
|
## Usage ##
|
|
|
|
[See GoDoc](http://godoc.org/github.com/oschwald/maxminddb-golang) for
|
|
documentation and examples.
|
|
|
|
## Examples ##
|
|
|
|
See [GoDoc](http://godoc.org/github.com/oschwald/maxminddb-golang) or
|
|
`example_test.go` for examples.
|
|
|
|
## Contributing ##
|
|
|
|
Contributions welcome! Please fork the repository and open a pull request
|
|
with your changes.
|
|
|
|
## License ##
|
|
|
|
This is free software, licensed under the ISC License.
|