Baguette/authd
3
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Minor README update (mostly a few links).

Browse Source
This commit is contained in:
Philippe Pittoli 2024-12-01 00:41:37 +01:00
parent b002c5851a
commit 242ec0b99d
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,25 +1,20 @@
# authd # 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`. > TODO: explain basic concepts behind `authd`.
## Build ## Build
`authd` is written in Crystal. `authd` is written in Crystal.
You’ll need the following tools: You’ll need the following tools to build it: `crystal`, `shards` and `make`.
- crystal
- shards
- make
To build authd, run the following commands:
``` ```
make make
make install
``` ```
## Deployment ## Run
``` ```
$ authd --help $ 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. Plus, the `admin` boolean value in the `AuthD::User` class.
> TODO: continue explaining design choices. > 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