diff --git a/README.md b/README.md index 4ac634a..192f8f6 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,20 @@ # authd -authd is a token-based authentication micro-service. +`authd` is a token-based authentication micro-service based on [libipc][libipc]. > TODO: explain basic concepts behind `authd`. ## Build `authd` is written in Crystal. -You’ll need the following tools: - - - crystal - - shards - - make - -To build authd, run the following commands: +You’ll need the following tools to build it: `crystal`, `shards` and `make`. ``` make +make install ``` -## Deployment +## Run ``` $ authd --help @@ -93,3 +88,7 @@ Some take a *UserID* to identify another user (its number or its login, both are Plus, the `admin` boolean value in the `AuthD::User` class. > TODO: continue explaining design choices. + +[libipc]: https://git.baguette.netlib.re/Baguette/libipc +[dnsmanagerd]: https://git.baguette.netlib.re/Baguette/dnsmanagerd +[netlibre]: https://netlib.re