aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Duncan <pabs@pablotron.org>2025-03-07 21:30:00 -0500
committerPaul Duncan <pabs@pablotron.org>2025-03-07 21:30:00 -0500
commitd736e677571972ee3819c6950bb4188d72c84dd1 (patch)
treefd1f709498226ac603028fa28392e48fcc5358d6
parentb4f57b895779d0fd599baa3a1ec033eb13ef5b37 (diff)
downloadjim-bot-d736e677571972ee3819c6950bb4188d72c84dd1.tar.xz
jim-bot-d736e677571972ee3819c6950bb4188d72c84dd1.zip
README.md: add usage section
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
index bfa18ce..743a626 100644
--- a/README.md
+++ b/README.md
@@ -4,5 +4,23 @@ Web interace which generates random corporate gibberish.
Based on [pocket-jim][]. Ported from C to Go.
+## Usage
+
+Build and run container using [Podman][]:
+
+ # clone git repo
+ git clone https://git.pablotron.org/jim-bot
+
+ # switch to cloned directory
+ cd jim-bot
+
+ # build container
+ podman build -t jim-bot:latest .
+
+ # run container
+ podman run -d -p 8080:8080 --restart=on-failure --name jim-bot jim-bot:latest
+
[pocket-jim]: https://pmdn.org/pocket-jim
"pocket jim"
+[podman]: https://podman.io/
+ "podman"