Skip to content

Commit 9f56fb1

Browse files
committed
Fix README
Signed-off-by: Matteo Collina <hello@matteocollina.com>
1 parent 883f2f5 commit 9f56fb1

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,6 @@
22

33
Wrap [Kafka](https://https://kafka.apache.org/) inside your application easily.
44

5-
This assumes that you have a Kafka cluster server running.
6-
7-
Then you can:
8-
9-
- Export the messages published on one or more topics to a HTTP endpoint.
10-
- Publish messages to a topic from a HTTP endpoint with a POST to the `/topics/:topic` endpoint.
11-
- Build request/response patterns over Kafka topics with HTTP-style semantics.
12-
135
## Features
146

157
- **Consume to HTTP**: Consume messages from Kafka topics and forward to HTTP endpoints
@@ -21,6 +13,20 @@ Then you can:
2113
- **Path parameters and query strings**: Automatic handling of URL parameters via Kafka headers
2214
- **Error handling**: Comprehensive timeout and error management
2315

16+
## Install with Watt
17+
18+
```bash
19+
npx wattpm@latest create
20+
```
21+
22+
And select `@platformatic/kafka-hooks` from the list of available packages.
23+
24+
## Install Standalone
25+
26+
```bash
27+
npx --package=@platformatic/kafka-hooks create-platformatic-kafka-hooks
28+
```
29+
2430
## Configuration
2531

2632
Configure your Kafka webhooks in the `platformatic.json` file:

0 commit comments

Comments
 (0)