docs: 更新说明文档

gear4jCenter · Jan 28, 2022 · 7afe19d · 7afe19d
1 parent 456e936
commit 7afe19d
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,20 @@
 # gh
+> Github 代理脚本
+
+[![Gh CI](https://github.com/gclm/gh/actions/workflows/release.yml/badge.svg)](https://github.com/gclm/gh/actions)
+
+## 使用教程
+```shell
+# git clone 
+gh git clone https://github.com/gclm/gh.git
+# curl/wget 
+gh curl https://github.com/gclm/gh.git
+gh wget https://github.com/gclm/gh.git
+```
+
+## 核心功能
+- 支持GitHub 文件 代理
+- 支持GitHub Releases  代理
+- 支持GitHub archive 代理
+- 支持GitHub gist 代理
+- 支持GitHub raw.githubusercontent.com 代理