From 9bdb1ad35c5870a8b3084055276b38e051de2398 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabiano=20Grac=CC=A7as?= Date: Fri, 7 Jan 2022 01:55:09 +0100 Subject: [PATCH] apply lint against MD file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabiano Graças --- README.md | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 203c19c..8a52a1f 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,22 @@ # VMWare Go KCL v2 ![technology Go](https://img.shields.io/badge/technology-go-blue.svg) -[![Go Report Card](https://goreportcard.com/badge/github.com/vmware/vmware-go-kcl)](https://goreportcard.com/report/github.com/vmware/vmware-go-kcl) +[![Go Report Card](https://goreportcard.com/badge/github.com/vmware/vmware-go-kcl-v2)](https://goreportcard.com/report/github.com/vmware/vmware-go-kcl-v2) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -[![vmware-go-kcl-v2](https://github.com/fafg/vmware-go-kcl/actions/workflows/vmware-go-kcl-v2-ci.yml/badge.svg)](https://github.com/fafg/vmware-go-kcl/actions/workflows/vmware-go-kcl-v2-ci.yml) +[![vmware-go-kcl-v2](https://github.com/fafg/vmware-go-kcl-v2/actions/workflows/vmware-go-kcl-v2-ci.yml/badge.svg)](https://github.com/fafg/vmware-go-kcl-v2/actions/workflows/vmware-go-kcl-v2-ci.yml) ## Overview -VMware-Go-KCL is a native open-source Go library for Amazon Kinesis Data Stream (KDS) consumption. It allows developers -to program KDS consumers in lightweight Go language and still take advantage of the features presented by the native +VMware-Go-KCL-V2 is a native open-source Go library for Amazon Kinesis Data Stream (KDS) consumption. It allows developers +to program KDS consumers in lightweight Go language and still take advantage of the features presented by the native KDS Java API libraries. -[vmware-go-kcl](https://github.com/vmware/vmware-go-kcl) is a VMWare originated open-source project for AWS Kinesis -Client Library in Go. Within VMware, we have seen adoption in vSecureState and Carbon Black. In addition, Carbon Black -has contributed to the vmware-go-kcl codebase and heavily used it in the product. Besides, -[vmware-go-kcl](https://github.com/vmware/vmware-go-kcl) has got -[recognition](https://www.linkedin.com/posts/adityakrish_vmware-go-kcl-a-native-open-source-go-programming-activity-6810626798133616640-B6W8/), -and [contributions](https://github.com/vmware/vmware-go-kcl/graphs/contributors) from the industry. +[vmware-go-kcl-v2](https://github.com/vmware/vmware-go-kcl-v2) is a VMWare originated open-source project for AWS Kinesis +Client Library in Go. Within VMware, we have seen adoption in vSecureState and Carbon Black. In addition, Carbon Black +has contributed to the vmware-go-kcl codebase and heavily used it in the product. Besides, +[vmware-go-kcl-v2](https://github.com/vmware/vmware-go-kcl-v2) has got +[recognition](https://www.linkedin.com/posts/adityakrish_vmware-go-kcl-a-native-open-source-go-programming-activity-6810626798133616640-B6W8/), +and [contributions](https://github.com/vmware/vmware-go-kcl-v2/graphs/contributors) from the industry. `vmware-go-kcl-v2` is the v2 version of VMWare KCL for the Go programming language by utilizing [AWS Go SDK V2](https://github.com/aws/aws-sdk-go-v2). @@ -31,21 +31,20 @@ and [contributions](https://github.com/vmware/vmware-go-kcl/graphs/contributors) ### Build & Run 1. Initialize Project -2. Build -`make build` +2. Build + > `make build` 3. Test - -`make test` + > `make test` ## Documentation VMware-Go-KCL matches exactly the same interface and programming model from original Amazon KCL, the best place for getting reference, tutorial is from Amazon itself: -- [Developing Consumers Using the Kinesis Client Library](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-kcl.html) -- [Troubleshooting](https://docs.aws.amazon.com/streams/latest/dev/troubleshooting-consumers.html) -- [Advanced Topics](https://docs.aws.amazon.com/streams/latest/dev/advanced-consumers.html) +* [Developing Consumers Using the Kinesis Client Library](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-kcl.html) +* [Troubleshooting](https://docs.aws.amazon.com/streams/latest/dev/troubleshooting-consumers.html) +* [Advanced Topics](https://docs.aws.amazon.com/streams/latest/dev/advanced-consumers.html) ## Contributing