Minor README update (mostly a few links).
This commit is contained in:
parent
b002c5851a
commit
242ec0b99d
17
README.md
17
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
|
||||
|
Loading…
Reference in New Issue
Block a user