Compare commits

...

2 Commits

Author SHA1 Message Date
bfd12ecf6b docs: add dev and deploy info to readme 2019-08-31 14:23:54 -07:00
86b20e1d7c chore: add readme and license 2019-08-31 14:21:48 -07:00
2 changed files with 51 additions and 0 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2018 joe fleming (https://github.com/w33ble)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

30
README.md Normal file
View File

@@ -0,0 +1,30 @@
# cannabis-dosing
![license](https://img.shields.io/badge/license-MIT-blue.svg)
Cannabis dosing calculator, useful for making oils, tinctures, butters, etc.
[https://cannabis-dosing.web.app](https://cannabis-dosing.web.app)
## Development
```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)