Cleanup

Author: vmihailenco

.prettierrc

@@ -0,0 +1,4 @@
+semi: false
+singleQuote: true
+proseWrap: always
+printWidth: 100

.travis.yml

@@ -1,14 +1,13 @@
 dist: xenial
-sudo: false
 language: go
 
 services:
   - redis-server
 
 go:
-  - 1.11.x
   - 1.12.x
   - 1.13.x
+  - 1.14.x
   - tip
 
 matrix:
@@ -21,4 +20,5 @@ env:
 go_import_path: github.com/go-redis/redis_rate
 
 before_install:
-  - curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go env GOPATH)/bin v1.21.0
+  - curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(go
+    env GOPATH)/bin v1.21.0

README.md

@@ -1,49 +1,57 @@
 # Rate limiting for go-redis
 
 [![Build Status](https://travis-ci.org/go-redis/redis_rate.svg?branch=master)](https://travis-ci.org/go-redis/redis_rate)
-[![GoDoc](https://godoc.org/github.com/go-redis/redis_rate?status.svg)](https://godoc.org/github.com/go-redis/redis_rate)
+[![GoDoc](https://godoc.org/github.com/go-redis/redis_rate?status.svg)](https://pkg.go.dev/github.com/go-redis/redis_rate/v9)
 
-This package is based on [rwz/redis-gcra](https://github.com/rwz/redis-gcra) and implements [GCRA](https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm) (aka leaky bucket) for rate limiting based on Redis. The code requires Redis version 3.2 or newer since it relies on [replicate_commands](https://redis.io/commands/eval#replicating-commands-instead-of-scripts) feature.
+This package is based on [rwz/redis-gcra](https://github.com/rwz/redis-gcra) and implements
+[GCRA](https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm) (aka leaky bucket) for rate
+limiting based on Redis. The code requires Redis version 3.2 or newer since it relies on
+[replicate_commands](https://redis.io/commands/eval#replicating-commands-instead-of-scripts)
+feature.
 
 ## Installation
 
-redis_rate requires a Go version with [Modules](https://github.com/golang/go/wiki/Modules) support and uses import versioning. So please make sure to initialize a Go module before installing redis_rate:
+redis_rate requires a Go version with [Modules](https://github.com/golang/go/wiki/Modules) support
+and uses import versioning. So please make sure to initialize a Go module before installing
+redis_rate:
 
-``` shell
+```shell
 go mod init github.com/my/repo
 go get github.com/go-redis/redis_rate/v8
 ```
 
 Import:
 
-``` go
+```go
 import "github.com/go-redis/redis_rate/v8"
 ```
 
 ## Example
 
-``` go
+```go
 package redis_rate_test
 
 import (
+	"context"
 	"fmt"
 
-	"github.com/go-redis/redis/v7"
-	"github.com/go-redis/redis_rate/v8"
+	"github.com/go-redis/redis/v8"
+	"github.com/go-redis/redis_rate/v9"
 )
 
 func ExampleNewLimiter() {
+	ctx := context.Background()
 	rdb := redis.NewClient(&redis.Options{
 		Addr: "localhost:6379",
 	})
-	_ = rdb.FlushDB().Err()
+	_ = rdb.FlushDB(ctx).Err()
 
 	limiter := redis_rate.NewLimiter(rdb)
-	res, err := limiter.Allow("project:123", redis_rate.PerSecond(10))
+	res, err := limiter.Allow(ctx, "project:123", redis_rate.PerSecond(10))
 	if err != nil {
 		panic(err)
 	}
-	fmt.Println(res.Allowed, res.Remaining)
-	// Output: true 9
+	fmt.Println("allowed", res.Allowed, "remaining", res.Remaining)
+	// Output: allowed 1 remaining 9
 }
 ```

rate.go

@@ -148,7 +148,7 @@ type Result struct {
 	// Limit is the limit that was used to obtain this result.
 	Limit *Limit
 
-	// Allowed reports whether event may happen at time now.
+	// Allowed is the number of events that may happen at time now.
 	Allowed int
 
 	// Remaining is the maximum number of requests that could be