aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDavid Skoland <davidskoland@gmail.com>2023-11-04 16:36:33 +0100
committerDavid Skoland <davidskoland@gmail.com>2023-11-04 16:36:33 +0100
commit453b71a33c072ee1fc7178c3f47d2962a67644df (patch)
tree2cb5490b70d3b14f67823593e402be2f76d2f082 /README.md
parent0036483242cd997761e7b05b80c706c33b880773 (diff)
Run linter on readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index 0ab336b..e30676d 100644
--- a/README.md
+++ b/README.md
@@ -3,25 +3,27 @@
This is a client for the Attorney Online roleplaying chatroom written in HTML and JavaScript.
It works with the any AO server if it has WebSocket support.
-Link to the client in this repo: http://web.aceattorneyonline.com/
+Link to the client in this repo: <http://web.aceattorneyonline.com/>
+
+## Project Setup
-# Project Setup
- Install [Node JS](https://nodejs.org/en/)
- Install nvm | [Windows](https://github.com/coreybutler/nvm-windows) , [Linux](https://github.com/nvm-sh/nvm)
-# Running Locally on Windows
+## Running Locally on Windows
+
1. Look at the file version in `.nvmrc` and run `nvm use <VERSION NUMBER>`
2. `npm install`
3. `npm run start`
+## Running Locally on Linux
-# Running Locally on Linux
1. `npm use`
2. `npm install`
3. `npm run start`
-# Running with Docker
+## Running with Docker
+
`docker build -t webao .`
`docker run -d -it -p 8080:8080 webao`
-