Skip to content

Commit 3e082b8

Browse files
committed
Add minor fixes to README.
1 parent c0e47b7 commit 3e082b8

File tree

1 file changed

+3
-15
lines changed

1 file changed

+3
-15
lines changed

README.md

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,32 +17,20 @@ kaf-relay is an opinionated, high performance program for keeping Kafka clusters
1717

1818
![image](./screenshots/relay.png)
1919

20-
## Prerequisites
21-
22-
* Go installed.
23-
* Access to the source and destination Kafka clusters.
24-
25-
## Installation
26-
27-
```bash
28-
git clone https://github.com/zerodha/kaf-relay.git
29-
cd kaf-relay
30-
make dist
31-
```
3220

3321
## Usage
3422

35-
To run Relay, follow these steps:
23+
To run kaf-relay, follow these steps:
3624

37-
Create a configuration file named config.toml with the necessary settings. You can use the provided config.example.toml file as a template.
25+
Copy config.sample.toml to config.toml and edit it accordingly. Then run:
3826

3927
```bash
4028
./kaf-relay.bin --config config.toml --mode <single/failover>
4129
```
4230

4331
### Filter plugins
4432

45-
Build your own filter plugins by implementing `filter.Provider` interface.
33+
Plugins allow to parse and filter incoming messages to allow or deny them from being replicated downstream. Build your own filter plugins by implementing `filter.Provider` interface.
4634

4735
Sample
4836
```golang

0 commit comments

Comments
 (0)