diff --git a/README.md b/README.md index cb54181..b382136 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,18 @@ curl -X POST http://localhost:4000/api/messages -H "Content-Type: application/js curl -X POST http://localhost:4001/api/messages -H "Content-Type: application/json" -d '{"from": "2-nibbler", "to": "1-bender", "message": "I am Nibbler, agent of the Nibblonian fleet."}' ``` +### Notes on queueing failed messages +When messages fail to be delivered they are queued for retry at 30 second interval with a maximum of 5 retries by default (can be configured) + ## Security This application uses a shared auth key (`AUTH_KEY`) to authenticate requests between servers. The key is provided as an environment variable and must be the same on all servers. -### Next steps +## Next steps + +### Security - HTTPS with client certificates HTTPS with client certificates should be implemented to ensure secure communication between servers and prevent unauthorized access and possible man-in-the-middle attacks. + +### Testing +Full suite of unit tests should be implemented to ensure the correctness of the application's logic and behavior. + +### Finish implementation of Message Queue to queue failed messages for retry