update README.md

zavier · Jun 25, 2020 · e2827fb · e2827fb
1 parent 32f191a
commit e2827fb
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,34 @@
 
 
 
-目前支持登录、注册，发送内容所有在线人员可见
+一个 telnet 版本的聊天服务器，主要有以下功能
+- 每个客户端可以用使用telnet ip:port的方式连接到服务器上。
+- 新连接需要用用户名和密码登录，如果没有，则需要注册一个。
+- 然后可以选择一个聊天室加入聊天。
+- 管理员有权创建或删除聊天室，普通人员只有加入、退出、查询聊天室的权力。
+- 聊天室需要有人数限制，每个人发出来的话，其它所有的人都要能看得到。
 
-使用（telnet)：
-telnet \<host\> \<port\>
+## 服务启动
+方法一、 通过Main方法启动即可
+
+方法二、 打包后，通过 java -jar 执行
+
+
+## 登录
+`telnet <host> <port>`
+
+## 增加/删除聊天室
+**（需要admin用户登录）**
+
+```
+增加:  cmd add <roomName>
+删除:  cmd del <roomName>
+```
+
+## 退出
+在聊天室时会退出聊天室，否则会退出会话
+`exit`
+
+
+
+![chat-demo](./doc/chat-demo.gif)
diff --git a/doc/chat-demo.gif b/doc/chat-demo.gif