Skip to content

Commit 8dfe1f5

Browse files
authored
Update README.md
1 parent 0248662 commit 8dfe1f5

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,19 @@ Serialise/deserialise flatbuffers blobs from kafka.
44
This currently deserialises https://github.com/ess-dmsc/python-streaming-data-types, but I am working to make it agnostic. Python bindings for the respective schema will need to be generated.
55

66
# Usage
7-
`saluki --help`
7+
See `saluki --help` for all options.
88

9-
# install
9+
## Listen to a topic for updates
10+
`saluki listen mybroker:9092/mytopic` - This will listen for updates for `mytopic` on `mybroker`.
11+
12+
## Consume from a topic
13+
`saluki consume mybroker:9092/mytopic -p 1 -o 123456 -m 10` - This will print 9 messages before (and inclusively the offset specified) offset `123456` of `mytopic` on `mybroker`, in partition 1.
14+
15+
Use the `-g` flag to go the other way, ie. in the above example to consume 9 messages FROM offset 123456
16+
17+
# Install
1018
`pip install saluki`
1119

12-
## developer setup
20+
## Developer setup
1321
`pip install .[dev]`
1422

0 commit comments

Comments
 (0)