diff --git a/README b/README index d17edae..159954b 100644 --- a/README +++ b/README @@ -1,4 +1,23 @@ -nostr-relay-registry --------------------- +# nostr-relay-registry -a dynamic registry of nostr relays that tests for very basic tasks in real-time. +A dynamic registry of nostr relays that tests for very basic tasks in real-time. + +## Docker + +Build the docker image: + +```bash +docker build -t nostr-relay-registry . +``` + +Run the container interactively: + +```bash +docker run --rm -it --name=nostr-relay-registry -p 8080:80 nostr-relay-registry +``` + +Run container in the background: + +```bash +docker run -d --restart unless-stopped --name nostr-relay-registry -p 8080:80 nostr-relay-registry +```