From bfd12ecf6bc626c166323a381c7fa36f7ba0da7c Mon Sep 17 00:00:00 2001 From: Joe Fleming Date: Sat, 31 Aug 2019 14:23:54 -0700 Subject: [PATCH] docs: add dev and deploy info to readme --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 482d6b8..cb05bdf 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,25 @@ Cannabis dosing calculator, useful for making oils, tinctures, butters, etc. [https://cannabis-dosing.web.app](https://cannabis-dosing.web.app) -#### License +## Development -MIT © [w33ble](https://github.com/w33ble) \ No newline at end of file +```sh +yarn +yarn dev +``` + +The `dev` script will start a simple web server. Note there is no automatic reloading. + +## Deployment + +If you are deploying to firebase, run `firebase init` to configure the project, then run the deploy script. + +```sh +yarn deploy +``` + +If deploying somewhere else simply deploy the `dist` path. + +## License + +MIT © [w33ble](https://github.com/w33ble)