Skip to content

Commit

Permalink
docs: Clarify Source & Sinks in the documentation. (#59)
Browse files Browse the repository at this point in the history
The README wasn't using the same terminology as the config. When I arrived at the config section, I was confused as to what a sink was.
  • Loading branch information
kusold authored Jul 10, 2024
1 parent 4a648a7 commit 57c1923
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Please see [LICENSE](LICENSE) for the full license text.

0 comments on commit 57c1923

Please sign in to comment.