Merge branch 'master' of https://github.com/Teahouse-Studios/bot

README.md

@@ -1,5 +1,36 @@
-# bot
+# 小可 · AkariBot v4
 
-The new readme is under construction...
+![GitHub issues](https://img.shields.io/github/issues/Teahouse-Studios/bot) ![GitHub pull requests](https://img.shields.io/github/issues-pr/Teahouse-Studios/bot) ![License](https://img.shields.io/github/license/Teahouse-Studios/bot) ![GitHub Repo stars](https://img.shields.io/github/stars/Teahouse-Studios/bot?style=social) ![GitHub tag](https://img.shields.io/github/v/tag/Teahouse-Studios/bot?include_prereleases)
 
-# 内容正在大幅调整中，可能不适合用于追求稳定性的运维
+
+## 介绍
+**小可**是基于多个框架开发的可扩展、多平台机器人。
+
+目前小可还正在持续开发中。
+
+## 平台
+小可目前支持以下平台：
+- QQ
+- Discord
+- Telegram
+
+## 运行
+### 公共实例
+茶馆工作室和问谛居共同提供小可的公共实例。
+
+#### Telegram
+链接：<https://t.me/oasisakaribot>，支持私聊和群聊。
+
+#### Discord
+暂不开放邀请。
+
+#### QQ
+目前QQ上稳定运行的小可实例为小可三号机，支持直接添加好友私聊。关于群聊，由于腾讯相关限制，请[在此提交](https://github.com/Teahouse-Studios/bot/issues/new?assignees=OasisAkari&labels=New&template=1234.md&title=)入群申请。
+
+暂不支持 QQ 频道。
+
+### 自搭建
+由于本项目设计时的局限性，小可并不适合自搭建。未来我们可能会提供自搭建的教程和文档。在此之前，若您有此需求，您可参考 [config.cfg.example](./config/config.cfg.example) 初步摸索配置；若遇到问题，可以通过 [issue](https://github.com/Teahouse-Studios/bot/issues/new) 或其他方式咨询开发者。
+
+## 许可
+小可继承 Mirai 项目，使用 AGPL-3.0 协议授权。详见 [./LICENSE](./LICENSE)。