Add readme

valarnin · Sep 13, 2021 · d983ec9 · d983ec9
1 parent e385bc4
commit d983ec9
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,19 @@
+# Oblivion save reader
+
+## To use on-demand:
+
+1. Download latest release
+2. Open `test.html` in browser
+3. Drag and drop `.ess` file onto page
+
+## To build from source:
+
+1. Clone repo
+2. `npm install`
+3. `npm build-prod && npm build-js`
+
+## To use websocket server:
+
+1. Follow steps to build from source
+2. `npm run server`
+3. Open test.html in browser, append `?WS=ws://127.0.0.1:8080/` to URL. Example: `file:///C:/Users/valar/Source/oblivion-save-reader/test.html?WS=ws://127.0.0.1:8080/`