Skip to content

Commit 2681c72

Browse files
chore(docs): refine GeoIP2-CN documentation with logo, configuration guide and usage section
1 parent ce01991 commit 2681c72

File tree

3 files changed

+67
-1
lines changed

3 files changed

+67
-1
lines changed

Docs/en-US/README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# **GeoIP2-CN: Auto Build and Update Solution**
1+
<!-- Aegis Logo -->
2+
<p align="center">
3+
<img src="https://raw.githubusercontent.com/Thoseyearsbrian/Aegis/main/assets/Aegis_Cover_Image.png" alt="Aegis Cover Image"/>
4+
</p>
5+
6+
<h1 align="center">GeoIP2-CN: Auto Build and Update Solution</h1>
27

38
<p align="center">
49
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License: Apache 2.0" />
@@ -12,6 +17,8 @@
1217
<a href="https://github.com/Thoseyearsbrian/GeoIP2-CN/blob/main/Docs/zh-CN/README.md"><b>【中文文档点此进入】</b></a>
1318
</p>
1419

20+
## **Overview**
21+
1522
This project provides a scripted solution and configuration for automatically downloading and building the official GeoLite2-Country.mmdb database from MaxMind, aiming to deliver a reliable, self-hosted, and regularly updated geolocation solution for network tools such as Surge, Clash,Shadowrocket and QuantumultX.
1623

1724
## **Project Background**
@@ -43,6 +50,21 @@ This project utilizes GitHub Actions for scheduled updates, pulling the latest d
4350

4451
## **Configuration Guide**
4552

53+
Configure MaxMind License Key (Required)
54+
55+
This project requires access to the official MaxMind GeoLite2 database. To enable automated updates, you must:
56+
57+
1. Register on [MaxMind](https://www.maxmind.com) and obtain your GeoLite2 License Key
58+
59+
2. Open your repository: GitHub → Settings → Secrets and variables → Actions
60+
61+
3. Create the following Secrets (names must match exactly):
62+
63+
- MAXMIND_ACCOUNT_ID # Your MaxMind Account ID (Required)
64+
- MAXMIND_LICENSE_KEY # Your MaxMind License Key (Required)
65+
66+
## **Usage Guide**
67+
4668
Copy the file URL → Open Surge → Go to General → GeoIP Database → Remove previous configuration (if any) → Paste the new URL → Update Now → Apply → Done!
4769

4870
<p align="center">

Docs/zh-CN/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!-- Aegis Logo -->
2+
<p align="center">
3+
<img src="https://raw.githubusercontent.com/Thoseyearsbrian/Aegis/main/assets/Aegis_Cover_Image.png" alt="Aegis Cover Image"/>
4+
</p>
5+
16
<h1 align="center">GeoIP2-CN 自动构建与更新方案</h1>
27

38
<p align="center">
@@ -12,6 +17,8 @@
1217
<a href="https://github.com/Thoseyearsbrian/GeoIP2-CN"><b>【English Documentation Here】</b></a>
1318
</p>
1419

20+
## 项目概述
21+
1522
本项目提供自动下载与构建 MaxMind 官方 GeoLite2-Country.mmdb 数据库的脚本与配置方案,旨在为 Surge、Clash 、Shadowrocket、QuantumultX等网络工具提供可信、自控、定期更新的地理定位支持。
1623

1724
## 项目背景
@@ -43,6 +50,21 @@
4350

4451
## 配置方式
4552

53+
配置 MaxMind License Key(必需)
54+
55+
本项目需要访问 MaxMind 官方 GeoLite2 数据库,因此您需要:
56+
57+
1.前往 [MaxMind 官网](https://www.maxmind.com) 注册账户并获取 GeoLite2 License Key
58+
59+
2.打开仓库:Secrets 配置列表(在 GitHub → Settings → Secrets → Actions 中添加)
60+
61+
3.新建以下 Secrets(名称必须完全一致):
62+
63+
- MAXMIND_ACCOUNT_ID # 你的 MaxMind Account ID (必填)
64+
- MAXMIND_LICENSE_KEY # 你的 MaxMind License Key(必填)
65+
66+
## 使用教程
67+
4668
复制文件路径 -> 打开 Surge -> 打开 通用 -> GeoIp数据库 -> 删除历史配置(如有) -> 粘贴链接 -> 现在更新 -> 应用 -> 完成!
4769

4870
<p align="center">

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!-- Aegis Logo -->
2+
<p align="center">
3+
<img src="https://raw.githubusercontent.com/Thoseyearsbrian/Aegis/main/assets/Aegis_Cover_Image.png" alt="Aegis Cover Image"/>
4+
</p>
5+
16
<h1 align="center">GeoIP2-CN 自动构建与更新方案</h1>
27

38
<p align="center">
@@ -12,6 +17,8 @@
1217
<a href="https://github.com/Thoseyearsbrian/GeoIP2-CN/blob/main/Docs/en-US/README.md"><b>【English Documentation Here】</b></a>
1318
</p>
1419

20+
## 项目概述
21+
1522
本项目提供自动下载与构建 MaxMind 官方 GeoLite2-Country.mmdb 数据库的脚本与配置方案,旨在为 Surge、Clash 、Shadowrocket、QuantumultX等网络工具提供可信、自控、定期更新的地理定位支持。
1623

1724
## 项目背景
@@ -43,6 +50,21 @@
4350

4451
## 配置方式
4552

53+
配置 MaxMind License Key(必需)
54+
55+
本项目需要访问 MaxMind 官方 GeoLite2 数据库,因此您需要:
56+
57+
1.前往 [MaxMind 官网](https://www.maxmind.com) 注册账户并获取 GeoLite2 License Key
58+
59+
2.打开仓库:Secrets 配置列表(在 GitHub → Settings → Secrets → Actions 中添加)
60+
61+
3.新建以下 Secrets(名称必须完全一致):
62+
63+
- MAXMIND_ACCOUNT_ID # 你的 MaxMind Account ID (必填)
64+
- MAXMIND_LICENSE_KEY # 你的 MaxMind License Key(必填)
65+
66+
## 使用教程
67+
4668
复制文件路径 -> 打开 Surge -> 打开 通用 -> GeoIp数据库 -> 删除历史配置(如有) -> 粘贴链接 -> 现在更新 -> 应用 -> 完成!
4769

4870
<p align="center">

0 commit comments

Comments
 (0)