Documentation update

JuliaWeb · Mar 23, 2021 · 4fad06e · 4fad06e
1 parent 3907ab2
commit 4fad06e
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 30 deletions.
diff --git 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
 <a href="http://www.maxmind.com">http://www.maxmind.com</a>.
-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
@@ -2,23 +2,23 @@
 
 *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
 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
@@ -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
 ```