Skip to content

Commit

Permalink
Adds more info to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
fgeller committed Jan 25, 2016
1 parent a7c2d34 commit 46ce2f4
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,32 @@
kt - a Kafka command line tool
# kt - a Kafka tool

## Example usage:

$ kt -help
Usage of kt:
-brokers string
Comma separated list of brokers. (default "localhost:9092")
-offset string
Colon separated offsets where to start and end reading messages.
-topic string
Topic to consume.
$ kt -topic kt-test
Partition=0 Offset=0 Key= Value=Hello, World 0
Partition=0 Offset=1 Key= Value=Hallo, Welt
Partition=0 Offset=2 Key= Value=Bonjour, monde
^C2016/01/26 06:29:19 Received interrupt - shutting down...
$ kt -topic kt-test -offset 1:
Partition=0 Offset=1 Key= Value=Hallo, Welt
Partition=0 Offset=2 Key= Value=Bonjour, monde
^C2016/01/26 06:29:29 Received interrupt - shutting down...
$ kt -topic kt-test -offset 1:1
Partition=0 Offset=1 Key= Value=Hallo, Welt
$

## Installation

You can download kt via the [Releases](https://github.com/fgeller/kt/releases) section.

Alternatively, the usual way via the go tool, for example:

$ GO15VENDOREXPERIMENT=1 go install github.com/fgeller/kt

0 comments on commit 46ce2f4

Please sign in to comment.