From 85ebee01852924e869b9d87087c369695e11b677 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=BE=90=E6=B6=9B?= <midnite@outlook.com>
Date: Mon, 17 Jul 2023 22:20:49 +0800
Subject: [PATCH] =?UTF-8?q?doc(read):=E5=A2=9E=E5=8A=A0=E8=AF=B4=E6=98=8E?=
 =?UTF-8?q?=E6=96=87=E6=A1=A3=E3=80=82?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c82ab77
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# AGTools
+
+本工具是利用[ag_toolsbox](https://git.archgrid.xyz/xt/ag_toolsbox)工具库编制的便捷工具，能够在命令行中实现 ag_toolsbox 中定义的绝大多数功能。
+
+```bash
+AGTools是一个基于ag_toolsbox开发的工具集合，主要提供了常用加密、散列、时间生成、随机字符串生成等方法。
+
+Usage:
+  agtools [command]
+
+Available Commands:
+  3des        3DES加密算法工具
+  aes         AES加密算法工具
+  base64      对给定内容进行base64编码或解码
+  completion  Generate the autocompletion script for the specified shell
+  crc16       CRC16校验
+  crc32       CRC32校验
+  crc64       CRC64校验
+  crc8        CRC8校验
+  des         DES加密算法工具
+  hail        使用冰雹ID生成算法生成一个唯一ID
+  help        Help about any command
+  md5         使用md5算法计算文件或者字符串的哈希值。
+  phash       使用pHash算法计算指定图像文件的感知哈希值。
+  rsa         RSA加密算法工具
+  sha1        使用Sha1算法计算文件或者字符串的哈希值
+  sha256      使用Sha256算法计算文件或字符串的哈希值。
+  sha512      使用Sha512算法计算文件或字符串的哈希值。
+  spiral      螺旋随机密钥自解密算法工具
+  verify_code 生成指定长度的随机验证码
+  version     输出当前工具版本号
+
+Flags:
+  -h, --help   help for agtools
+
+Use "agtools [command] --help" for more information about a command.
+```
+
+工具的具体使用方法可参考工具的自身的帮助说明。
+
+本工具使用 Go 1.20.5 编写，支持 macOS、Windows 与 Linux 等常见平台。