README.md

@@ -1,3 +1,54 @@
 # VSSM_Web - VintageStory Server Manager Web UI
-A web based frontend for the VSSM project, written in Svelte
+A simple web based frontend for the [VSSM project](https://git.bellsworne.tech/chrisbell/vssm), written in React TypeScript
 
+## IMPORTANT INFORMATION
+This project is currently in development, and thus everything is subject to change
+
+## About
+VSSM_Web in a frontent for the VSSM project that allows you to create and manage multiple VS servers
+
+## Installation and Usage
+There are no binaries just yet, so you have to download the source files.
+
+Requirements: 
+- nodejs
+- npm
+
+***If you are using NixOS, a flake.nix is provided, just run `nix develop` for a full development enviroment***
+
+Usage:
+- Download the source code
+- In the `vssm_web` directory, run `npm install`
+- cd into `vssm_web` and run `npm dev run`
+- Open in broweser window
+
+## Configuration
+WIP
+
+## Roadmap
+
+- [ ] Server instance management
+    - [x] Multiple servers support
+    - [x] List servers and their status
+    - [x] Create instances
+    - [x] Delete instance
+    - [x] Start/Stop instances
+    - [ ] Server configuration
+        - [x] Server Name
+        - [x] Port
+        - [ ] Full instance configuration
+    - [ ] Console
+        - [ ] Fully interactive instance console 
+            - [ ] Send commands to servers
+            - [ ] View logs
+    - [ ] Automated server backups
+
+- [ ] Access authentication
+- [ ] Configuration
+- [ ] Binary releases
+- [ ] Automatically set up background service
+
+- [ ] Other
+    - [ ] First class NixOS support
+        - [ ] Official nix package or flake
+            - [ ] All configuration options