From ee8862be810ad6008dc49ef9be7ae6aba2555be5 Mon Sep 17 00:00:00 2001
From: Greg Heartsfield <scsibug@imap.cc>
Date: Sat, 11 Dec 2021 22:19:49 -0600
Subject: [PATCH] docs: README gives quickstart for docker

---
 README.md | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b2925d9..9f4e1b5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-[nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay)
-===
+# [nostr-rs-relay](https://git.sr.ht/~gheartsfield/nostr-rs-relay)
 
 This is a [nostr](https://github.com/fiatjaf/nostr) relay, written in
 Rust.  It currently supports the entire relay protocol, and has a
@@ -9,6 +8,26 @@ The project master repository is available on
 [sourcehut](https://sr.ht/~gheartsfield/nostr-rs-relay/), and is
 mirrored on [GitHub](https://github.com/scsibug/nostr-rs-relay).
 
+## Quick Start
+
+The provided `Dockerfile` will compile and build the server application.  Use a bind mount to store the SQLite database outside of the container image, and map the container's 8080 port to a host port (8090 in the example below).
+
+```console
+$ docker build -t nostr-rs-relay .
+$ docker run -p 8090:8080 --mount src=$(pwd)/nostr_data,target=/usr/src/app/db,type=bind nostr-rs-relay
+```
+
+Use a `nostr` client such as [`noscl`](https://github.com/fiatjaf/noscl) to publish and query events.
+
+```console
+$ noscl publish "hello world"
+Sent to 'ws://localhost:8090'.
+Seen it on 'ws://localhost:8090'.
+$ noscl home
+Text Note [81cf...2652] from 296a...9b92 5 seconds ago
+  hello world
+```
+
 License
 ---
 This project is MIT licensed.