增加readme文档HEADmaster

1 files changed, 17 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..fa42556
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,17 @@
+# Timerbot
+
+Telegram定时提醒机器人。
+
+## 部署方法
+
+用stack构建，然后在项目目录中创建文件`tgtoken`，写入bot的token。
+
+## 使用
+
+命令格式:
+
+    /timer <分钟数>
+
+只能设置一天内的提醒。提醒队列长度上限为4096个。
+
+提醒不会写入磁盘，程序重启后提醒队列中的内容会丢失。