Skip to content

Commit 57c1923

Browse files
authored
docs: Clarify Source & Sinks in the documentation. (#59)
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.
1 parent 4a648a7 commit 57c1923

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@ You can read more about inhooks in the [launch blog post](https://didil.medium.c
1717
![Inhooks Architecture](inhooks-architecture.png?raw=true "Inhooks Architecture")
1818

1919
### High level overview
20-
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.
20+
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.
21+
22+
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.
2123

2224
## Features
2325
- Receive HTTP Webhooks and save them to a Redis database
24-
- Fanout messages to multiple HTTP targets
26+
- Fanout messages to multiple HTTP targets (sinks)
2527
- Fast, concurrent processing
2628
- Supports delayed processing
2729
- 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
219221
Copyright (c) 2023 Adil H.
220222

221223
Inhooks is an Open Source project licensed under the terms of the LGPLv3 license.
222-
Please see [LICENSE](LICENSE) for the full license text.
224+
Please see [LICENSE](LICENSE) for the full license text.

0 commit comments

Comments
 (0)