diff --git a/README.md b/README.md index 86318d8..1f99087 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,13 @@ You can read more about inhooks in the [launch blog post](https://didil.medium.c ![Inhooks Architecture](inhooks-architecture.png?raw=true "Inhooks Architecture") ### High level overview -Inhooks listens to HTTP webhooks and saves the messages to Redis. A processing module retrieves the messages and sends them reliably to the defined targets. +Inhooks consists of two major concepts, Sources and Sinks. A Source is an endpoint for receiving webhooks, and a [Sink](https://en.wikipedia.org/wiki/Sink_(computing)) is a target that receives the webhooks. + +Inhooks listens to HTTP webhooks and saves the messages to Redis. A processing module retrieves the messages and sends them reliably to the defined sinks. ## Features - Receive HTTP Webhooks and save them to a Redis database -- Fanout messages to multiple HTTP targets +- Fanout messages to multiple HTTP targets (sinks) - Fast, concurrent processing - Supports delayed processing - Supports retries on failure with configurable number of attempts, interval and constant or exponential backoff @@ -219,4 +221,4 @@ Feel free to open new issues or PRs ! You can also reach out to the maintainer a Copyright (c) 2023 Adil H. Inhooks is an Open Source project licensed under the terms of the LGPLv3 license. -Please see [LICENSE](LICENSE) for the full license text. \ No newline at end of file +Please see [LICENSE](LICENSE) for the full license text.