Browse Source

update readme

master
dwelle 3 years ago
parent
commit
89ff6477f7
1 changed files with 18 additions and 0 deletions
  1. 18
    0
      README.md

+ 18
- 0
README.md View File

@@ -1,3 +1,21 @@
1 1
 # Excalidraw Portal
2 2
 
3 3
 Collaboration server for Excalidraw
4
+
5
+# Development
6
+
7
+- install
8
+
9
+  ```sh
10
+  yarn
11
+  ```
12
+
13
+- run development server
14
+
15
+  ```sh
16
+  yarn start:dev
17
+  ```
18
+
19
+# Deployment
20
+
21
+NOTE: currently the server IS NOT deployed automatically on push to the `master` branch, and must be done so manually by an admin.

Loading…
Cancel
Save