diff --git a/README.md b/README.md index dad5fca12728ecc3dfdd944028561b65e3981619..77b02bdcfb3203d4cd2542d5cad19a3450455466 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# RoleGame \ No newline at end of file +# RoleGame + +## Dependencies + +### Used +* `express`: Fast, unopinionated, minimalist web framework +* `bcrypt`: A bcrypt library for NodeJS. +* `express-session`: Simple session middleware for Express +* `pug`: A clean, whitespace-sensitive template language for writing HTML +* `mongoose`: Mongoose MongoDB ODM +* `body-parser`: Node.js body parsing middleware + +### To use +* `joi`: Object schema description language and validator for JavaScript objects. + +## Release + +### Next: v0.1.0 +* [X] Authentication and session +* [ ] Validate mongoose models +* [ ] Make mongoose unique index work + +### Next: v0.2.0 +* [ ] Message handler diff --git a/package.json b/package.json index cc7f87ddc741331db5d3625e4ab48815f38e8f7c..0e2d5b37695e9254abc12fa8d46a9a2e9bef4808 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,15 @@ { + "scripts": { + "dev": "nodemon index.js" + }, "dependencies": { + "bcrypt": "^3.0.4", + "body-parser": "^1.18.3", "eslint": "^5.13.0", - "mongoose": "^5.4.11" + "express": "^4.16.4", + "express-session": "^1.15.6", + "mongoose": "^5.4.11", + "nodemon": "^1.18.10", + "pug": "^2.0.3" } }