Add a readme

mouminoux · Apr 5, 2019 · 534bb58 · 534bb58
1 parent 1c9d0a3
commit 534bb58
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,17 @@
+# Kafkacli
+
+Kafkacli is a consumer and producer client for Apache Kafka.
+
+### Usage:
+```
+kafkacli [-b] -t... [--from-beginning] [-g] [-m] [-h...]
+
+Options:                 
+  -b, --broker           brokers (default "localhost:9092")
+  -t, --topic            topic
+      --from-beginning   start with the earliest message
+  -g, --consumer-group   consumer group id
+  -m, --message          message message
+  -h, --header           message header <key=value>
+
+```
diff --git a/kafkacli.go b/kafkacli.go
@@ -16,7 +16,7 @@ import (
 )
 
 func main() {
-	app := cli.App("kafkacli", "Kafka consumer")
+	app := cli.App("kafkacli", "Kafkacli")
 	app.Spec = "[-b] -t... [--from-beginning] [-g] [-m] [-h...]"
 	var (
 		bootstrapServers = app.StringOpt("b broker brokers", "localhost:9092", "brokers")