summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..00d38a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# wsChat
+
+A simple IRC-like chat made using nodejs and webSockets
+
+## Running the server
+
+To install dependencies:
+
+```bash
+npm install
+```
+
+To run:
+
+```bash
+node index.js
+```
+
+## TODO
+
+- Make commands be in an object instead of a switch statement
+- /help command
+- /about command
+- Config (JSON)
+- MOTD
+- Custom commands