From 4c0b95c7ea2b81b8db68a8fcb40726a061fe00e5 Mon Sep 17 00:00:00 2001
From: yennanliu <f339339@gmail.com>
Date: Tue, 7 Nov 2023 14:30:07 +0800
Subject: [PATCH] update readme

---
 springChatRoom/README.md | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

diff --git a/springChatRoom/README.md b/springChatRoom/README.md
index d1499918b..fc9d25edd 100644
--- a/springChatRoom/README.md
+++ b/springChatRoom/README.md
@@ -1,28 +1,37 @@
 # Spring Chat Room
 
-- UI : http://localhost:8080
+Build a chat system with webSocket, run in Spring boot system.
 
-## Run
-```bash
-```
+- UI : http://localhost:8080
 
 ## Tech
 - Java 11
 - spring boot 3.0.12
 - webSocket
 - STOMP
+- FE
+  - SockJS (webSocket client)
 - Extension
-  - Redis
+    - Redis
+
+## Run
+```bash
+mvn package -DskipTests
+java -jar target/springChatRoom-0.0.1-SNAPSHOT.jar
+```
 
 ## Todo
 - Feature
   - private msg (1 to 1)
-  - group chat
+  - setup group, group chat
   - @ "notification"
   - msg push (?)
   - "read" 已讀 feature
   - show user list
   - save history msg
+  - broadcast msg
+  - push msg to users (offer API)
+  - offer user counts/online users (offer API)
 
 ## Knowledge
 - WebSocket