git.sr.ht/~pingoo/stdx@v0.0.0-20240218134121-094174641f6e/mmdb/README.md (about)

     1  # MaxMind DB Reader for Go #
     2  
     3  [![GoDoc](https://godoc.org/git.sr.ht/~pingoo/stdx/mmdb?status.svg)](https://godoc.org/git.sr.ht/~pingoo/stdx/mmdb)
     4  
     5  This is a Go reader for the MaxMind DB format. Although this can be used to
     6  read [GeoLite2](http://dev.maxmind.com/geoip/geoip2/geolite2/) and
     7  [GeoIP2](https://www.maxmind.com/en/geoip2-databases) databases,
     8  [geoip2](https://github.com/oschwald/geoip2-golang) provides a higher-level
     9  API for doing so.
    10  
    11  This is not an official MaxMind API.
    12  
    13  ## Installation ##
    14  
    15  ```
    16  go get git.sr.ht/~pingoo/stdx/mmdb
    17  ```
    18  
    19  ## Usage ##
    20  
    21  [See GoDoc](http://godoc.org/git.sr.ht/~pingoo/stdx/mmdb) for
    22  documentation and examples.
    23  
    24  ## Examples ##
    25  
    26  See [GoDoc](http://godoc.org/git.sr.ht/~pingoo/stdx/mmdb) or
    27  `example_test.go` for examples.
    28  
    29  ## Contributing ##
    30  
    31  Contributions welcome! Please fork the repository and open a pull request
    32  with your changes.
    33  
    34  ## License ##
    35  
    36  This is free software, licensed under the ISC License.