aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 54cae47..08be012 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,12 @@
# webAO
-This is a client for the Attorney Online roleplaying chatroom written in HTML and JavaScript.
-It works with any AO server if it has WebSocket support.
+A fork of WebAO, the browser client for AO2. WebAO originally made by
+stonedDiscord and the WebAO contributors.
-Link to the client in this repo: <http://web.aceattorneyonline.com/>
+Upstream repository: <https://github.com/AttorneyOnline/webAO>
+
+This fork has minimal changes and was made to fix a few issues and be compatible
+with CSDWASASH, the AO2 server deployed at Serenade of Flames.
## Project Setup
@@ -12,7 +15,8 @@ Link to the client in this repo: <http://web.aceattorneyonline.com/>
## Running Locally
1. `bun install`
-2. `bun run start`
+2. `bun run start` to run at localhost:8080 in development mode
+3. `bun run build` to build artifacts in `dist`
## Running with Docker