From 84a31a8ae8b657fbe846a02ffb78447a1f789124 Mon Sep 17 00:00:00 2001 From: Atul Singh Date: Sun, 8 Mar 2026 22:27:05 +0100 Subject: [PATCH] feat: Add authentication section to README Added authentication section detailing API Key and JWT usage. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index d5ec81e..8dd5914 100644 --- a/README.md +++ b/README.md @@ -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 + +Example: + +curl -H "Authorization: ApiKey your-api-key" \ +http://localhost:8080/messages ## Architecture Overview