summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorSoniEx2 <endermoneymod@gmail.com>2019-04-28 18:55:02 -0300
committerSoniEx2 <endermoneymod@gmail.com>2019-04-28 18:55:02 -0300
commit32b76dd2cf26f6e8e815a45c3b958a42aea27d42 (patch)
tree3a9bcb6bdc9d4078b32144fb0a3d46ef5b835304
parent63a5e3f8c9fbc3f961198e4bfa55f6321870be39 (diff)
Update README.md
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index b8cdc58..39c1953 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,10 @@ More importantly, it's a tool to help fight against BDFLs and other forms of cen
 Usage
 -----
 
+Note: GAnarchy does not come with a main page. You need to provide one yourself. This should be in your website's `/` path (usually `index.html`).
+The protocol handler uses the path `/?url=%s`. Additionally, your main page needs to include the `index.js` provided by GAnarchy
+for the protocol handler to properly work.
+
 First, initialize the database with `ganarchy.py initdb`. The database is stored in the XDG data home, as per XDG spec.
 
 Then, set the project commit with `ganarchy.py set-commit COMMIT`, where `COMMIT` is the full commit hash.