From 72c51b692380b53b5eae78dc7e7efc18f5382c98 Mon Sep 17 00:00:00 2001
From: Simon Ser <contact@emersion.fr>
Date: Wed, 1 Jul 2020 14:46:49 +0200
Subject: [PATCH] readme: add more detailed usage instructions

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index f76ae08..9bfda5f 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,44 @@ A bare-bones IRC web client.
 
 Requires an IRC WebSocket server.
 
+First install dependencies:
+
+    npm install --production
+
+### [soju]
+
+Add a WebSocket listener to soju, e.g. `listen wss://127.0.0.1:8080`.
+
+Configure your reverse proxy to serve gamja files and proxy `/socket` to soju.
+
+### [webircgateway]
+
+Setup webircgateway to serve gamja files:
+
+```ini
+[fileserving]
+enabled = true
+webroot = /path/to/gamja
+```
+
+Then connect to webircgateway and append `?server=/webirc/websocket/` to the
+URL.
+
+### Development server
+
+Start your IRC WebSocket server, e.g. on port 8080. Then run:
+
     npm install
     npm start
 
+This will start a development HTTP server for gamja. Connect to it and append
+`?server=ws://localhost:8080` to the URL.
+
 ## License
 
 AGPLv3, see LICENSE.
 
 Copyright (C) 2020 The gamja Contributors
+
+[soju]: https://soju.im
+[webircgateway]: https://github.com/kiwiirc/webircgateway