Merge pull request #38 from dotkernel/issue-37

Marked package as wrapper
dotkernel · Jul 4, 2024 · 13950ed · 13950ed
2 parents 9371638 + bee0da8
commit 13950ed
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,9 @@
 # dot-geoip
 
-DotKernel component based on Maxmind's [geoip2/geoip2](https://github.com/maxmind/GeoIP2-php) package, using [db-ip.com's free GeoLite2 databases](https://db-ip.com/db/) to provide geographical details about an IP address.
+> [!IMPORTANT]
+> dot-geoip is a wrapper on top of [dot-geoip](https://github.com/maxmind/GeoIP2-php)
+>
+> ![OSS Lifecycle](https://img.shields.io/osslifecycle/maxmind/GeoIP2-php)
 
 ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-geoip)
 ![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-geoip/3.6.0)

diff --git a/docs/book/v3/overview.md b/docs/book/v3/overview.md
@@ -0,0 +1,5 @@
+# Overview
+
+> dot-geoip is a wrapper on top of [dot-geoip](https://github.com/maxmind/GeoIP2-php)
+>
+> ![OSS Lifecycle](https://img.shields.io/osslifecycle/maxmind/GeoIP2-php)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,6 +8,7 @@ extra:
 nav:
   - Home: index.md
   - v3:
+      - Overview: v3/overview.md
       - Configuration: v3/configuration.md
       - Installation: v3/installation.md
       - "Manage GeoLite2 database": v3/manage-geolite2-database.md