From 7eb3bf0b440acb3f131a4610757762f1349a9347 Mon Sep 17 00:00:00 2001
From: Niko Abeler <niko@rerere.org>
Date: Sun, 25 Feb 2024 20:29:41 +0100
Subject: [PATCH] update README with build and run

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/README.md b/README.md
index b41d09c..0e60f76 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,32 @@ A simple web server for blogs generated from Markdown files.
 
 **_This project is not yet stable. Expect frequent breaking changes! Only use this if you are willing to regularly adjust your project accordingly._**
 
+
+
+## Build
+
+```
+CGO_ENABLED=1 go build -o owl ./cmd/owl
+```
+
+## Run
+
+To run the web server use the command:
+
+```
+owl web
+```
+
+The blog will run on port 3000 (http://localhost:3000)
+
+To create a new account:
+
+```
+owl new-author -u <name> -p <password>
+```
+
+To retrieve a list of all commands run:
+
+```
+owl -h
+```
\ No newline at end of file