diff --git a/README.md b/README.md index 8272618..01337f1 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ -# auth-server \ No newline at end of file +# LAB - Class 11, 13, 14 + +## Project: Auth Server + +### Author: Dave Wolfe + +### Links and Resources + +- [submission PR](https://github.com/wolfes-401-advanced-javascript/auth-server/pull/4) +- [ci/cd](http://xyz.com) (GitHub Actions) +- [back-end server url](http://xyz.com) (when applicable) +- [front-end application](http://xyz.com) (when applicable) + +### Setup + +#### `.env` requirements (where applicable) + +i.e. + +- `PORT` - 3000 +- `MONGODB_URI` - URL to the running mongo instance/db + +#### How to initialize/run your application (where applicable) + +- e.g. `node index.js` + +#### How to use your library (where applicable) + +#### Tests + +- How do you run tests? +- Any tests of note? +- Describe any tests that you did not complete, skipped, etc + +#### UML + +Link to an image of the UML for your application and response to events