aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Coquand <marcc@fastmail.fr>2023-12-03 12:56:32 -0600
committerMarc Coquand <marcc@fastmail.fr>2023-12-03 12:56:32 -0600
commita61ba98a6f6787a4f5345d80238703f9faa5e7d1 (patch)
treee0668f45bbd9c280e8191db513681d0520375482
parent42ba69a713eafa2a5640d3313f6057f1993e7d57 (diff)
downloadwormhole-a61ba98a6f6787a4f5345d80238703f9faa5e7d1.tar.gz
wormhole-a61ba98a6f6787a4f5345d80238703f9faa5e7d1.tar.bz2
wormhole-a61ba98a6f6787a4f5345d80238703f9faa5e7d1.zip
Update readme
Diffstat (limited to '')
-rw-r--r--readme.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index c99d9ba..d898a5e 100644
--- a/readme.md
+++ b/readme.md
@@ -12,7 +12,9 @@ I built it in OCaml because it is by far the most underrated programming languag
## Prerequisites
-You'll need `libev` and `openssl`.
+You'll need `libev`, `gmp` and `openssl`. See the Dockerfile.
+
+At some point I'll post this all to nix so you can use nix-shell.
## Running locally
@@ -20,6 +22,12 @@ You'll need `libev` and `openssl`.
ENV=DEV DISABLE_AUTH=true dune exec --watch --root . wormhole
```
+Dev flag adds some mock data.
+
+## Allow list
+
+There is a allow list in bin/main.ml that you will need to update to allow specific actors to make posts. This is a safety precaution as there is no federation yet.
+
## Build
```