add readme

This commit is contained in:
foosinn 2020-08-31 22:57:57 +02:00
parent 00a2504fb2
commit 3f371972a0

21
README.md Normal file
View file

@ -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
```