diff --git a/README.md b/README.md index 7ae439d..c703c3e 100644 --- a/README.md +++ b/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/ diff --git a/app/publish/flags.go b/app/publish/flags.go index 73439e2..81fbb31 100644 --- a/app/publish/flags.go +++ b/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 } diff --git a/app/subscribe/flags.go b/app/subscribe/flags.go index 5c8c55f..fae63d6 100644 --- a/app/subscribe/flags.go +++ b/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 } diff --git a/publisher/gocloud.go b/publisher/gocloud.go index e3852cc..ab733fb 100644 --- a/publisher/gocloud.go +++ b/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" diff --git a/subscriber/gocloud.go b/subscriber/gocloud.go index dd3d344..42be38d 100644 --- a/subscriber/gocloud.go +++ b/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"