From 3f371972a0aa3cde02e3068072a780bd570dad27 Mon Sep 17 00:00:00 2001
From: foosinn <stefan@f2o.io>
Date: Mon, 31 Aug 2020 22:57:57 +0200
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3901535
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# mac4nick
+
+`mac4nick` is a small and self contained webinterface to manage the MAC address
+assingment for Hackerspace Bamberg members.
+
+It features an option to update existing MAC entries, unlike the existing
+solutions.
+
+## Usage
+
+```sh
+$ mac4nick --help
+Configuration
+
+Options:
+  --listen          listen address
+  --dsn             database dsn
+  --session-secret  session secret
+  --log             debug
+  --help            display usage information
+```