diff --git a/README.md b/README.md index bddb8f8..98921eb 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ # Golang Kinesis Consumer -Note: This repo has been upgraded to use AWS SDK v2. If you are still using -AWS SDK V1: https://github.com/harlow/kinesis-consumer/releases/tag/v0.3.5 - ![technology Go](https://img.shields.io/badge/technology-go-blue.svg) [![Build Status](https://travis-ci.com/harlow/kinesis-consumer.svg?branch=master)](https://travis-ci.com/harlow/kinesis-consumer) [![GoDoc](https://godoc.org/github.com/harlow/kinesis-consumer?status.svg)](https://godoc.org/github.com/harlow/kinesis-consumer) [![GoReportCard](https://goreportcard.com/badge/github.com/harlow/kinesis-consumer)](https://goreportcard.com/report/harlow/kinesis-consumer) Kinesis consumer applications written in Go. This library is intended to be a lightweight wrapper around the Kinesis API to read records, save checkpoints (with swappable backends), and gracefully recover from service timeouts/errors. @@ -19,6 +16,9 @@ Get the package source: $ go get github.com/harlow/kinesis-consumer +Note: This repo now requires the AWS SDK V2 package. If you are still using +AWS SDK V1 then use: https://github.com/harlow/kinesis-consumer/releases/tag/v0.3.5 + ## Overview The consumer leverages a handler func that accepts a Kinesis record. The `Scan` method will consume all shards concurrently and call the callback func as it receives records from the stream.