diff --git a/README.md b/README.md index 059ef25..6756dad 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ -# Express API Starter +# APL Esports Nuke -This is an API Starter written in node.js and express for the ease of creating backend projects. +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. -`TODO: Fill Readme` +## Todos + +- [ ] data + - [ ] create channels + - [ ] create migrations with stream consideration + - [ ] read from db + - [ ] create data + - [ ] update data +- [ ] authentication + - [ ] create collection + - [ ] cache tokens on startup + - [ ] allow create, update only on authentication \ No newline at end of file diff --git a/package.json b/package.json index 6483aea..9d58e92 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "nuke", - "version": "1.2.0", + "version": "1.0.0", "description": "APL Esports' Nuke Server", "main": "index.js", "scripts": { diff --git a/src/app.js b/src/app.js index d53040f..dd25757 100644 --- a/src/app.js +++ b/src/app.js @@ -17,7 +17,7 @@ app.use(cors()) app.get('/', (req, res) => { res.json({ - message: 'Hello!' + message: 'APL Esports Nuke v1.0.0' }) })