From 3d607984d339086124d8145fbe7deab96c4d12c4 Mon Sep 17 00:00:00 2001
From: Adrian Victor <adrianvictor@disroot.com>
Date: Wed, 13 Nov 2024 08:09:55 -0300
Subject: [PATCH] Added readme.

---
 .gitignore   |  2 ++
 package.json |  7 +++----
 readme       | 13 +++++++++++++
 server.ts    |  2 +-
 4 files changed, 19 insertions(+), 5 deletions(-)
 create mode 100644 .gitignore
 create mode 100644 readme

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..25c8fdb
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+package-lock.json
\ No newline at end of file
diff --git a/package.json b/package.json
index b1dbada..659ed59 100644
--- a/package.json
+++ b/package.json
@@ -1,15 +1,14 @@
 {
-  "name": "~2024-ia24-chat",
+  "name": "chatto-server",
   "version": "1.0.0",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
     "start": "ts-node server.ts"
   },
   "keywords": [],
-  "author": "",
+  "author": "Adrian Victor <adrianvictor@disroot.org>",
   "license": "ISC",
-  "description": "",
+  "description": "A simple ephemeral messaging server",
   "dependencies": {
     "ws": "^8.18.0"
   },
diff --git a/readme b/readme
new file mode 100644
index 0000000..b4d3d78
--- /dev/null
+++ b/readme
@@ -0,0 +1,13 @@
+# Chatto
+This is a chat server that uses WebSocket for communication, born in a college class. It should be as simple as possible, providing a quick way of communication.
+
+## What Chatto is:
+- A ephemeral messaging server
+
+## What Chato is not:
+- A - in any way - secure messaging server
+- A messaging app on it's own
+- Something you should use as a private messaging solution
+- A server that provides any solution of client-side security (you can uncomment a line to 'disable' HTML injection, but that's all you have server-side), your client will have to handle everything on it's own.
+
+I'm making this server to learn TS and improve my front-end skills, and I'm planning to host a client in my friend's private website, just to have a waterfall of messages where anyone can send something. The base code was made by my teacher (reportedly using Copilot) so I'm planning to refactor it.
\ No newline at end of file
diff --git a/server.ts b/server.ts
index 6e59152..e2170a4 100644
--- a/server.ts
+++ b/server.ts
@@ -67,4 +67,4 @@ wss.on('connection', (ws) => {
   });
 });
 
-console.log('WebSocket server is running on ws://localhost:8080');
\ No newline at end of file
+console.log('Chatto WebSocket server is running on ws://localhost:4000');
\ No newline at end of file