From 8b8b6a2f7cdb65f474e8c5f89059b4cbce4ac360 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Skirt=E2=9C=BF?=
 <91937041+X-Skirt-X@users.noreply.github.com>
Date: Thu, 25 Aug 2022 19:05:36 +0800
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0c32954
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# 话痨排行榜
+
+## 版本
+
+v1.0 可以选择看每天的话痨排行榜啦！
+
+⚠ 适配nonebot2-2.0.0b5+
+
+## 安装
+
+1. 通过`pip`或`nb`安装；
+
+>**通过pip**安装
+
+`pip install nonebot-plugin-dialectlist`
+
+>**通过nb**安装
+
+`nb plugin install nonebot_plugin_emojimix`
+
+## 配置
+
+需要提前配置本插件依赖的插件！
+
+### 插件依赖于
+
+1. [nonebot-plugin-chatrecorder](https://github.com/noneplugin/nonebot-plugin-chatrecorder) ————获取历史的消息
+
+2. [nonebot-plugin-datastore](https://github.com/he0119/nonebot-plugin-datastore) ————储存历史的消息
+
+
+## 命令
+
+-`/群话痨排行榜` ————看看有史以来（机器人存在以来）群友们发了多少消息！
+
+-`/今日群话痨排行榜` ————看看今天的群友发了多少消息！
+
+-`/昨日群话痨排行榜` ————看看昨天的群友发了多少消息！
+
+-`/本周群话痨排行榜` ————看看本周的群友发了多少消息！
+
+-`/本月群话痨排行榜` ————看看这个月的群友发了多少消息！
+
+-`/年度群话痨排行榜` ————看看今年的群友发了多少消息！
+
+-`/历史群话痨排行榜` ————看看历史上（机器人存在以来）的群友发了多少消息！
+
+## 另外
+
+### 感谢
+本插件的__init__.py中的处理函数参考了词云中的方法 ~~（其实大部分都是Ctrl+C Ctr+V）~~
+
+[nonebot-plugin-wordcloud](https://github.com/he0119/nonebot-plugin-wordcloud)
+
+