From c34d55fd531cbdc1182142c215854307e6050869 Mon Sep 17 00:00:00 2001
From: Ayush Mukherjee <me@ayushm.com>
Date: Fri, 12 Mar 2021 05:08:34 +0530
Subject: [PATCH] update readme with deployment instructions

---
 README.md | 18 ++++--------------
 1 file changed, 4 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index bf18fed..57fd451 100644
--- a/README.md
+++ b/README.md
@@ -3,18 +3,8 @@
 This is a **real-time** websocket service for handling live updates of stream data. This includes basic token authentication
 through the CMS for creating/updating data.
 
-## Todos
+## Instructions to deploy
 
-- [x] data
-  - [x] create migrations with stream consideration
-  - [x] read from db
-  - [x] create data
-  - [x] update data
-  - [x] delete data
-- [x] websocket
-  - [x] create ws server
-  - [x] handle events
-- [x] authentication
-  - [x] create collection
-  - [x] figure out auth
-- [x] casters and hosts stuff
\ No newline at end of file
+1. Copy `env.example` as `.env` and fill in the details (make sure `NODE_ENV` is set to production)
+2. Run `npm i`
+3. Expose port 5000 or use a reverse proxy which supports WebSockets
\ No newline at end of file