Updated README.md

ChatApp/README.md

@@ -1,18 +1,32 @@
-## Getting Started
+# ChatAPP
+An instant messaging app using Java and the UDP protocol.
 
-Welcome to the VS Code Java world. Here is a guideline to help you get started to write Java code in Visual Studio Code.
+## How to run
 
-## Folder Structure
+> [!WARNING]
+> As of now, the app rely on ANSI escape character, thus not available on Windows.
+> However, this feature is under development.
 
-The workspace contains two folders by default, where:
+You can run the app by launching the `ChatApp` class. This will create the server (port `6665`) and a first client,
+(creating by the way a room (`101`)).
 
-- `src`: the folder to maintain sources
+You can then create more clients by launching the `Client` class. It will connect to the server 
-- `lib`: the folder to maintain dependencies
+(be sure you launched it first) on the default port `6665`.
 
-Meanwhile, the compiled output files will be generated in the `bin` folder by default.
+## How to use
+As soon as you launch a client, you will be prompted to enter your name. You will then be in the lobby. From here you 
+can join whatever room that is created, and you will be able to chat with the other clients in the room.
+You will also be able to create a new room.
 
-> If you want to customize the folder structure, open `.vscode/settings.json` and update the related settings there.
+## Commands
+> [!TIP]
+> The commands can be found by typing `/help` in the chat, in the lobby or in any room.
 
-## Dependency Management
+> [!NOTE]
+> All the commands are prefixed by `/`.
 
-The `JAVA PROJECTS` view allows you to manage your dependencies. More details can be found [here](https://github.com/microsoft/vscode-java-dependency#manage-dependencies).
+- /createRoom *roomName*
+- /listRooms
+- /joinRoom *roomName*
+- /leaveRoom
+- /help