update documentation

iamatypeofwalrus · Jan 22, 2019 · 9f5af19 · 9f5af19
1 parent cd5954c
commit 9f5af19
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
 # kpr -> Kinesis Put Records
+This tool uses [Go Modules](https://github.com/golang/go/wiki/Modules) for its dependencies :-)
+
 ## Install
 ```
 go get -u github.com/iamatypeofwalrus/kpr
@@ -9,13 +11,15 @@ $ kpr -h
 NAME:
    kpr - Kinesis Put Records
 
-   A simple CLI that takes input from STDIN and sends it to an AWS Kinesis stream
+   A simple CLI that takes input from STDIN and sends it to an AWS Kinesis or Firehose stream
 
 USAGE:
    cat your_records.json | kpr --stream YOUR_STREAM_NAME --region us-west-2
 
 GLOBAL OPTIONS:
-   --stream NAME, -s NAME      Kinesis stream NAME
-   --region REGION, -r REGION  Amazon Web Service REGION (default: "us-east-1")
-   --help, -h                  show this help message
+   --stream NAME, -s NAME               Kinesis stream NAME
+   --region REGION, -r REGION           Amazon Web Service REGION (default: "us-east-1")
+   --delimiter DELIMITER, -d DELIMITER  Kinesis Firehose DELIMITER (default: "\n")
+   --help, -h                           show this help message
+   --verbose                            log verbosely
 ```
diff --git a/main.go b/main.go
@@ -19,7 +19,7 @@ import (
 func main() {
 	app := cli.NewApp()
 	app.Name = "kpr"
-	app.Usage = "Kinesis Put Records\n\n   A simple CLI that takes input from STDIN and sends it to an AWS Kinesis stream"
+	app.Usage = "Kinesis Put Records\n\n   A simple CLI that takes input from STDIN and sends it to an AWS Kinesis or Firehose stream"
 	app.UsageText = "cat your_records.json | kpr --stream YOUR_STREAM_NAME --region us-west-2"
 	app.Version = "0.1.0"
 	app.HideHelp = true