diff --git a/LICENSE.md b/LICENSE.md index 15a1adc..9a62791 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,27 +1,27 @@ The GeoIP.jl package is licensed under the MIT Expat License: -> Copyright (c) 2014: Seth Bromberger and contributors -> -> Permission is hereby granted, free of charge, to any person obtaining -> a copy of this software and associated documentation files (the -> "Software"), to deal in the Software without restriction, including -> without limitation the rights to use, copy, modify, merge, publish, -> distribute, sublicense, and/or sell copies of the Software, and to -> permit persons to whom the Software is furnished to do so, subject to -> the following conditions: -> -> The above copyright notice and this permission notice shall be -> included in all copies or substantial portions of the Software. -> -> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -> IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -> CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -> TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +Copyright (c) 2021: Andrey Oskin and contributors -This product includes GeoLite2 data created by MaxMind, available from +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +This product uses, but not include GeoLite2 data created by MaxMind, available from http://www.maxmind.com. -The GeoLite2 databases are distributed under the Creative Commons -Attribution-ShareAlike 3.0 Unported License. +The GeoLite2 databases are distributed under the [GeoLite2 End User License Agreement +](https://www.maxmind.com/en/geolite2/eula). diff --git a/README.md b/README.md index 5ed88c9..f87c81f 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,16 @@ *IP Geolocalization using the [Geolite2](https://dev.maxmind.com/geoip/geoip2/geolite2/) Database* -| *Package Evaluator* | *Build Status* | *Coverage* | -|:-------------------:|:--------------:|:----------:| -| [![GeoIP](http://pkg.julialang.org/badges/GeoIP_0.6.svg)](http://pkg.julialang.org/?pkg=GeoIP&ver=0.6) | [![Build Status](https://travis-ci.org/JuliaWeb/GeoIP.jl.svg?branch=master)](https://travis-ci.org/JuliaWeb/GeoIP.jl) | [![Coverage Status](https://coveralls.io/repos/github/JuliaWeb/GeoIP.jl/badge.svg)](https://coveralls.io/github/JuliaWeb/GeoIP.jl) | +| **Documentation** | **Build Status** | +|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| +| [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaWeb.github.io/GeoIP.jl/stable)[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaWeb.github.io/GeoIP.jl/dev) | [![Build](https://github.com/JuliaWeb/GeoIP.jl/workflows/CI/badge.svg)](https://github.com/JuliaWeb/GeoIP.jl/actions)[![Coverage](https://codecov.io/gh/JuliaWeb/GeoIP.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaWeb/GeoIP.jl) | -### Usage +## Usage `GeoIP.geolocate(IPv4)` will load data from the CSV if it's not already loaded. -### Example +## Example ```julia using GeoIP @@ -19,6 +19,6 @@ a = ip"1.2.3.4" geolocate(a) # returns dictionary with all relevant information ``` -### Acknowledgements -This product includes GeoLite2 data created by MaxMind, available from +## Acknowledgements +This product uses, but not include, GeoLite2 data created by MaxMind, available from [http://www.maxmind.com](http://www.maxmind.com). diff --git a/docs/src/index.md b/docs/src/index.md index dd8646f..e79c814 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -4,6 +4,25 @@ CurrentModule = GeoIP # GeoIP +*IP Geolocalization using the [Geolite2](https://dev.maxmind.com/geoip/geoip2/geolite2/) Database* + +## Usage + +`GeoIP.geolocate(IPv4)` will load data from the CSV if it's +not already loaded. + +## Example + +```julia +using GeoIP +a = ip"1.2.3.4" +geolocate(a) # returns dictionary with all relevant information +``` + +## Acknowledgements +This product uses, but not include, GeoLite2 data created by MaxMind, available from +[http://www.maxmind.com](http://www.maxmind.com). + ```@index ```