nerdcult
/
api
4
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): updated readme

This commit is contained in:
antifallobst 2023-08-17 15:27:05 +02:00
parent ab8f145d3f
commit 781bc912c4
Signed by: antifallobst
GPG Key ID: 2B4F402172791BAF
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,5 +7,17 @@ The source can be found in `src` and the docs in `API.md`.
You can run the server with the following command: You can run the server with the following command:
``` ```
export DATABASE_URL=mysql://user:password@host/database export DATABASE_URL=mysql://user:password@host/database
export SMTP_HOST_URL=smtp.yourmailserver.tld
export SMTP_USER=accounts@yourdomain.tld
export SMTP_PASSWORD=password
./nerdcult_api ./nerdcult_api
``` ```
## Implementation Status
- `/accounts`
- [X] `/register` - POST
- [X] `/verify` - POST
- [X] `/authenticate` - POST
- [X] `/delete` - DELETE
- [ ] `/tokens` - DELETE
- [ ] `/tokens` - GET