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