update xssbook to work with crimson updates

1 files changed, 21 insertions, 8 deletions

diff --git a/README.md b/README.md
index f291e21..5afcf94 100644
--- a/README.md
+++ b/README.md
@@ -16,22 +16,35 @@ To get the checkout run:
 ```sh
 git clone https://g.freya.cat/freya/xssbook2 xssbook2
 cd xssbook2
+git submodule update --init
 ```
 
-XSSBook v2 runs in docker compose. To run, you MUST do ALL of the following:
+XSSBook v2 runs in docker compose. Do ALL of the following:
 
-    - Update PROJECT_DIR in .env to be an absolute path to your current directory
-    - Build all css source from sass by running `make`
-    - Use `site/compose` instead of docker compose
+- MUST Copy `example.env` to `.env`
+- MUST update the following settings in `.env`
+  - `API_SECRET` - Your own private JWT secret
+  - `XSSBOOK_*` - Domain info for XSSBook is being hosted
+    - NOT REQUIRED in [development](https://g.freya.cat/freya/crimson/src/branch/main/src/config.php#L20) mode
+- MAY want to update the following settings in `.env`
+  - `HTTP_BIND` - The addresses XSSBook will listen on
+  - `HTTP_PORT` - The port XSSBook will listen on
+  - `ENVIRONMENT` - If you want to test XSSBook in [development] mode
+- MUST build the following assets by running `make`
+  - CSS files. MUST have `sassc` installed
+- MUST use `site/bin/compose` instead of `docker compose`
 
-Finally, to build the images and start, run:
+Once XSSBook is configured properly. Run the following to build the container
+images and start up the compose stack for XSSBook.
 
 ```sh
-./site/compose build --pull
-./site/compose up -d
+./site/bin/compose build --pull
+./site/bin/compose up -d
 ```
 
-> NOTE: You many want to change is HTTP_PORT and HTTP_BIND in .env.
+> NOTE: XSSBook needs all docker volumes to be owned by uid 1000 gid 1000. If
+  you are NOT the root user or user 1000:1000, the compose script will ask for
+  sudo access to be able to set the volume permissions.
 
 ### migrating from xssbook v1