update readme

2021-10-28 15:55:46 +02:00 · 2021-10-28 15:55:46 +02:00 · 89ff6477f7
commit 89ff6477f7
parent c07fcccc69
1 changed files with 18 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,21 @@
 # Excalidraw Portal

 Collaboration server for Excalidraw
+
+# Development
+
+- install
+
+  ```sh
+  yarn
+  ```
+
+- run development server
+
+  ```sh
+  yarn start:dev
+  ```
+
+# Deployment
+
+NOTE: currently the server IS NOT deployed automatically on push to the `master` branch, and must be done so manually by an admin.