Readme

2021-11-11 20:15:19 +01:00
parent 10e5f2481f
commit db0849c6c2
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+## Requirements
+- yarn
+- npm
+
+## Usage
+- Clone repo
+- cd into dir
+- `yarn install`
+
+### Building
+- `yarn run build`
+
+### Start local instance
+- `yarn run watch` for hot recompile on changes
+- `yarn run monitor` for hot reload on recompile
+
+### Start normal instance
+- `yarn run start`