From bdbf39219bc5c16cdbbbd1d5a227edd87d56b34a Mon Sep 17 00:00:00 2001
From: JP Appel <jeanpierre.appel01@gmail.com>
Date: Wed, 2 Oct 2024 12:22:33 -0400
Subject: Add README with instructions

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f223a2c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# Nonsense Time
+
+Back-end for Nonsense Time campaign
+
+## Building
+
+Tested for go1.23 `linux/amd64` and `darwin/amd64`
+
+```
+make build
+```
+
+## Installation
+
+```
+make install
+```
+
+## Running
+
+The server can be started via the `nonsense-time` binary.
+It accepts the following options:
+
+```
+-p <PORT>               default 8080
+    server listening port
+-b <BIND_ADDRESS>       default 0.0.0.0
+    network address to bind to
+-w <WAIT_TIME>          default 2 seconds
+    maximum wait time for timed requests
+-v
+    verbose output
+```
+
+## SystemD Service
+
+A SystemD service is provided but not installed by default.
-- 
cgit v1.2.3