diff --git a/README.md b/README.md new file mode 100644 index 0000000..560e643 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# This Is Your Life + +This is a simple generator that automates the process of generating a Dungeons & Dragons 5th Edition character based on the random tables in the Player Handbook, Volo's Guide to Monsters, Xanathar's Guide to Everything and accompanying material. + +## Initializing + +Run `npm i` to install all required dependencies before running the development server. + +## Development server + +Run `npm run test` for a dev server. Navigate to `http://localhost:8080/`. The app will automatically reload if you change any of the source files. + +## Build + +Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory. + +## Running unit tests + +Run `npm test` to execute the unit tests via [Jasmine](https://jasmine.github.io/). + +## Versioning + +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/trwolfe13/brewdown/tags). + +## Authors + +* **Tom Wolfe** - *Initial work* - [trwolfe13](https://github.com/trwolfe13) + +See also the list of [contributors](https://github.com/trwolfe13/this-is-your-life/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details \ No newline at end of file