From fae36fd812914cf08522bc6a0a0c91555548bc99 Mon Sep 17 00:00:00 2001 From: Nikita Date: Fri, 6 May 2022 11:44:39 +0300 Subject: [PATCH] improve functionality - add DefaultRedis wrapper - fix middleware nil pointer - upd linter - upd pipeline - upd docs --- .github/workflows/go.yml | 2 ++ README.md | 18 ++++++++++++------ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 2557979..d427f8e 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -3,6 +3,8 @@ on: push: branches: - main + tags: + - "*" pull_request: branches: - main diff --git a/README.md b/README.md index 9acf57a..e552f6f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,12 @@ # go-ratelimiter -A super easy rate limiting package for Go. Package defines Store storage interface, for which you can use your own +[![Go Report](https://goreportcard.com/badge/github.com/robotomize/go-ratelimiter)](https://goreportcard.com/report/github.com/robotomize/gokuu) +[![codebeat badge](https://codebeat.co/badges/a4a12b24-98e6-4627-b01c-8b124561f2e1)](https://codebeat.co/projects/github-com-robotomize-go-ratelimiter-main) +[![codecov](https://codecov.io/gh/robotomize/go-ratelimiter/branch/main/graph/badge.svg)](https://codecov.io/gh/robotomize/go-ratelimiter) +[![Build status](https://github.com/robotomize/go-ratelimiter/actions/workflows/go.yml/badge.svg)](https://github.com/robotomize/go-ratelimiter/actions) +[![GitHub license](https://img.shields.io/github/license/robotomize/go-ratelimiter.svg)](https://github.com/robotomize/go-ratelimiter/blob/master/LICENSE) + +A super easy rate limiting package for Go. Package provide Store interface, for which you can use your own implementations # Install @@ -116,15 +122,15 @@ func main() { # TODO * ~add http middleware~ -* ~add simple redis datastore~ -* extend Store methods +* ~add redis datastore~ +* improve unit coverage * improve redis datastore -* try using tarantool datastore -* try using aerospike datastore +* add tarantool datastore +* add aerospike datastore ## Contributing ## License -go-ratelimiter is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. \ No newline at end of file +go-ratelimiter is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.