feat: Add authentication section to README

Added authentication section detailing API Key and JWT usage.
This commit is contained in:
Atul Singh
2026-03-08 22:27:05 +01:00
committed by GitHub
parent cc6f466c72
commit 84a31a8ae8
+14
View File
@@ -97,6 +97,20 @@ Simply use dokcer compose to do all the job for you
docker compose up
```
## Authentication
The HTTP API is protected using **API Key or JWT authentication**.
You must include one of the following headers in every request.
### API Key
Authorization: ApiKey <your-api-key>
Example:
curl -H "Authorization: ApiKey your-api-key" \
http://localhost:8080/messages
## Architecture Overview