docs(readme): updated readme
This commit is contained in:
parent
ab8f145d3f
commit
781bc912c4
14
README.md
14
README.md
|
@ -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:
|
||||
```
|
||||
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
|
||||
```
|
||||
```
|
||||
|
||||
## Implementation Status
|
||||
- `/accounts`
|
||||
- [X] `/register` - POST
|
||||
- [X] `/verify` - POST
|
||||
- [X] `/authenticate` - POST
|
||||
- [X] `/delete` - DELETE
|
||||
- [ ] `/tokens` - DELETE
|
||||
- [ ] `/tokens` - GET
|
Loading…
Reference in New Issue