improved docs

README.md

@@ -6,6 +6,29 @@ Go package to provide a common interface for abstract publish and subscribe oper
 
 Documentation is incomplete at this time.
 
+## Tools
+
+```
+$> make cli
+go build -mod vendor -ldflags="-s -w" -o bin/publish cmd/publish/main.go
+go build -mod vendor -ldflags="-s -w" -o bin/subscribe cmd/subscribe/main.go
+```
+
+## Examples
+
+```
+$> ./bin/publish \
+	-publisher-uri 'awssqs-creds://?region={REGION}&credentials={CREDENTIALS}&queue-url=https://sqs.{REGION}.amazonaws.com/{ACCOUNT}/{QUEUE}' \
+	'hello world'
+```
+
+```
+$> ./bin/subscribe \
+	-subscriber-uri 'awssqs-creds://?region={REGION}&credentials={CREDENTIALS}&queue-url=https://sqs.{REGION}.amazonaws.com/{ACCOUNT}/{QUEUE}'
+2024/09/04 10:59:57 INFO Listening for messages
+hello world
+```
+
 ## See also
 
 * https://gocloud.dev/howto/pubsub/

app/publish/flags.go

@@ -11,7 +11,7 @@ var mode string
 
 func DefaultFlagSet() *flag.FlagSet {
 	fs := flagset.NewFlagSet("publish")
-	fs.StringVar(&publisher_uri, "publisher-uri", "", "...")
-	fs.StringVar(&mode, "mode", "", "...")
+	fs.StringVar(&publisher_uri, "publisher-uri", "", "A valid sfomuseum/go-pubsub/publisher.Publisher URI")
+	fs.StringVar(&mode, "mode", "", "Optional flag to signal whether data should be read for an alternate source. Valid options are: readline, stdin.")
 	return fs
 }

app/subscribe/flags.go

@@ -11,7 +11,7 @@ var publisher_uri string
 
 func DefaultFlagSet() *flag.FlagSet {
 	fs := flagset.NewFlagSet("subscribe")
-	fs.StringVar(&subscriber_uri, "subscriber-uri", "", "...")
-	fs.StringVar(&publisher_uri, "publisher-uri", "stdout://?newline=true", "...")
+	fs.StringVar(&subscriber_uri, "subscriber-uri", "", "A valid sfomuseum/go-pubsub/subscriber.Subscriber URI")
+	fs.StringVar(&publisher_uri, "publisher-uri", "stdout://?newline=true", "A valid sfomuseum/go-pubsub/publisher.Publisher URI")
 	return fs
 }

publisher/gocloud.go

@@ -1,5 +1,7 @@
 package publisher
 
+// ./bin/publish -publisher-uri 'awssqs-creds://?region={REGION}&credentials={CREDENTIALS}&queue-url=https://sqs.{REGION}.amazonaws.com/{ACCOUNT}/{QUEUE}' 'hello world'
+
 import (
 	"context"
 	"fmt"

subscriber/gocloud.go

@@ -1,6 +1,7 @@
 package subscriber
 
 // https://gocloud.dev/howto/pubsub/subscribe/
+// ./bin/subscribe -subscriber-uri 'awssqs-creds://?region={REGION}&credentials={CREDENTIALS}&queue-url=https://sqs.{REGION}.amazonaws.com/{ACCOUNT}/{QUEUE}'
 
 import (
 	"context"