diff --git a/README.md b/README.md index 8011176..8494f39 100644 --- a/README.md +++ b/README.md @@ -343,6 +343,14 @@ func main() { } ``` +# Examples + +There are example Produder and Consumer code in `/cmd` directory. These should help give end-to-end examples of setting up consumers with different checkpoint strategies. + +The examples run locally against [Kinesis Lite](https://github.com/mhart/kinesalite). + + $ kinesalite + ## Contributing Please see [CONTRIBUTING.md] for more information. Thank you, [contributors]! diff --git a/examples/consumer/cp-dynamo/README.md b/cmd/consumer-dynamo/README.md similarity index 100% rename from examples/consumer/cp-dynamo/README.md rename to cmd/consumer-dynamo/README.md diff --git a/examples/consumer/cp-dynamo/main.go b/cmd/consumer-dynamo/main.go similarity index 100% rename from examples/consumer/cp-dynamo/main.go rename to cmd/consumer-dynamo/main.go diff --git a/examples/consumer/cp-mysql/README.md b/cmd/consumer-mysql/README.md similarity index 100% rename from examples/consumer/cp-mysql/README.md rename to cmd/consumer-mysql/README.md diff --git a/examples/consumer/cp-mysql/main.go b/cmd/consumer-mysql/main.go similarity index 100% rename from examples/consumer/cp-mysql/main.go rename to cmd/consumer-mysql/main.go diff --git a/examples/consumer/cp-postgres/README.md b/cmd/consumer-postgres/README.md similarity index 100% rename from examples/consumer/cp-postgres/README.md rename to cmd/consumer-postgres/README.md diff --git a/examples/consumer/cp-postgres/main.go b/cmd/consumer-postgres/main.go similarity index 100% rename from examples/consumer/cp-postgres/main.go rename to cmd/consumer-postgres/main.go diff --git a/examples/consumer/cp-redis/README.md b/cmd/consumer-redis/README.md similarity index 100% rename from examples/consumer/cp-redis/README.md rename to cmd/consumer-redis/README.md diff --git a/examples/consumer/cp-redis/main.go b/cmd/consumer-redis/main.go similarity index 100% rename from examples/consumer/cp-redis/main.go rename to cmd/consumer-redis/main.go diff --git a/examples/producer/README.md b/cmd/producer/README.md similarity index 100% rename from examples/producer/README.md rename to cmd/producer/README.md diff --git a/examples/producer/main.go b/cmd/producer/main.go similarity index 100% rename from examples/producer/main.go rename to cmd/producer/main.go diff --git a/examples/producer/users.txt b/cmd/producer/users.txt similarity index 100% rename from examples/producer/users.txt rename to cmd/producer/users.txt diff --git a/examples/README.md b/examples/README.md deleted file mode 100644 index b613ec1..0000000 --- a/examples/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# Examples - -Here are examples of Produder and Consumer code to provide guidance on how to use each of the different checkpoints. - -The examples will run against [Kinesis Lite](https://github.com/mhart/kinesalite). - - $ kinesalite