aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVidhu Kant Sharma <vidhukant@vidhukant.com>2026-07-20 15:43:16 +0530
committerVidhu Kant Sharma <vidhukant@vidhukant.com>2026-07-20 15:43:16 +0530
commit3a089525cbc8a5b0ba86878e3fe5deec663a0f81 (patch)
tree8797f4b7295f682a8685df433786a1fc6698c3b5
parentee21d50441852d2556144c16e065afde1229c765 (diff)
fix mistakes in README
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index 840aed0..275d7c1 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,24 @@
Standalone guestbook server meant to be paired up with a static website.
+## Installation
+
+Install with `go install` (`$GOPATH/bin` must be added to `$PATH`):
+
+```fish
+go install vidhukant.com/guestbook@latest
+```
+
+Or, build yourself:
+
+```fish
+git clone https://git.vidhukant.com/guestbook
+cd guestbook
+go build .
+```
+
+Then move the `guestbook` binary into `$PATH` yourself.
+
# Usage
## Configuration
@@ -60,7 +78,7 @@ StartLimitIntervalSec=0
Type=simple
Restart=on-failure
RestartSec=1
-ExecStart=guestbook --guestbook my_guestbook
+ExecStart=guestbook serve --guestbook my_guestbook
[Install]
WantedBy=multi-user.target