Add readme

2023-02-07 12:36:41 -05:00
parent d9f8653f32
commit 28e8783519
1 changed files with 7 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,7 @@
+# CollabVM1.ts
+This is a drop-in replacement for the dying CollabVM 1.2.11. Still in alpha.
+
+## Running
+1. Copy config.example.toml to config.toml, and fill out fields
+2. Build it: `npm run build`
+3. Run it: `npm run serve`