From a27a13f40517d8d97a13a6b021cae49dffae9106 Mon Sep 17 00:00:00 2001 From: Harlow Ward Date: Sat, 23 May 2015 16:18:10 -0700 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 085b24e..491eaae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Golang Kinesis Connectors -#### Kinesis connector applications written in Go +__Kinesis connector applications written in Go__ Inspired by the [Amazon Kinesis Connector Library][1]. These components are used for extracting streaming event data into S3, Redshift, DynamoDB, and more. See the [API Docs][2] for package documentation. @@ -8,12 +8,12 @@ into S3, Redshift, DynamoDB, and more. See the [API Docs][2] for package documen [1]: https://github.com/awslabs/amazon-kinesis-connectors [2]: http://godoc.org/github.com/harlow/kinesis-connectors +![golang_kinesis_connector](https://cloud.githubusercontent.com/assets/739782/4262283/2ee2550e-3b97-11e4-8cd1-21a5d7ee0964.png) + ## Overview Each Amazon Kinesis connector application is a pipeline that determines how records from an Amazon Kinesis stream will be handled. Records are retrieved from the stream, transformed according to a user-defined data model, buffered for batch processing, and then emitted to the appropriate AWS service. -![golang_kinesis_connector](https://cloud.githubusercontent.com/assets/739782/4262283/2ee2550e-3b97-11e4-8cd1-21a5d7ee0964.png) - A connector pipeline uses the following interfaces: * __Pipeline:__ The pipeline implementation itself. @@ -27,14 +27,25 @@ A connector pipeline uses the following interfaces: Get the package source: $ go get github.com/harlow/kinesis-connectors + +Import the `go-kinesis` and `kinesis-connector` packages: -### Examples +```go +package main -Examples pipelines are proviede in [examples directory][demo]. +import ( + "github.com/harlow/kinesis-connectors" + "github.com/sendgridlabs/go-kinesis" +) +``` -[demo]: https://github.com/harlow/kinesis-connectors/tree/master/examples +### Example Pipelines -### Custom Logging +Examples pipelines are proviede in [examples directory][example]. + +[example]: https://github.com/harlow/kinesis-connectors/tree/master/examples + +### Logger Default logging is handled by Package log. An application can override the defualt package logging by changing it's `logger` variable: @@ -47,14 +58,14 @@ The customer logger must implement the [Logger interface][log_interface]. [log_interface]: https://github.com/harlow/kinesis-connectors/blob/master/logger.go -### Contributing +## Contributing Please see [CONTRIBUTING.md] for more information. Thank you, [contributors]! [LICENSE]: /MIT-LICENSE [CONTRIBUTING.md]: /CONTRIBUTING.md -### License +## License Copyright (c) 2015 Harlow Ward. It is free software, and may be redistributed under the terms specified in the [LICENSE] file.