From cc05af8a24288b7a6bf78a086a7e1fa5621d4e54 Mon Sep 17 00:00:00 2001
From: LamGC <lam827@lamgc.net>
Date: Wed, 20 May 2020 11:00:25 +0800
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7d7b33e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# ContentGrabbingJi
+Pixiv爬虫一只，同时也是一个机器人/插件！
+
+## 支持的机器人平台 ##
+- [Mirai](https://github.com/mamoe/mirai)
+- [CoolQ](https://cqp.cc)(基于`SpringCQ`, 不支持多账号使用, 需要使用`CQHttp`插件)
+
+## Usage ##
+### 参数 ###
+- `proxy` / `CGJ_PROXY`: 设置代理
+- `botDataDir` / `CGJ_BOT_DATA_DIR`: 设置`botMode`运行模式下机器人数据存储目录
+- `redisAddress` / `CGJ_REDIS_URI`: Redis服务器地址