README.md: add "Build" and "Tests" sections, minor wording changes

1 files changed, 33 insertions, 3 deletions

diff --git a/README.md b/README.md
index 743a626..834e9ca 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 # jim-bot
 
-Web interace which generates random corporate gibberish.
+Web interace which generates 10 sentences of random corporate gibberish.
 
-Based on [pocket-jim][].  Ported from C to Go.
+Based on [pocket-jim][].  Ported from C to [Go][].
 
 ## Usage
 
@@ -17,10 +17,40 @@ Build and run container using [Podman][]:
     # build container
     podman build -t jim-bot:latest .
 
-    # run container
+    # run container bound to localhost:8080
     podman run -d -p 8080:8080 --restart=on-failure --name jim-bot jim-bot:latest
 
+Then open <http://localhost:8080/> in your browser.
+
+## Build
+
+To build locally (requires [Go][]):
+
+    # build ./jim-bot
+    make
+
+    # run jim-bot on localhost:8080
+    ./jim-bot
+
+Then open <http://localhost:8080/> in your browser.
+
+## Tests
+
+Running tests:
+
+    # run unit tests
+    make test
+
+    # run `go vet` and `staticcheck`
+    make check
+
+Note: The `check` target requires [staticcheck][].
+
 [pocket-jim]: https://pmdn.org/pocket-jim
   "pocket jim"
 [podman]: https://podman.io/
   "podman"
+[go]: https://go.dev/
+  "Go programming language"
+[staticcheck]: https://staticcheck.dev/docs/
+  "Go static analyzer."