Added deprecate notice to NewClient(). Updated Readme with documentation links and Pkg.go.dev examples. (#29)

* [add] Added deprecate notice to NewClient() Please use NewClientFromPool() instead. [add] Updated Readme with documentation links and Pkg.go.dev examples

Author: filipecosta90

.github/release-drafter-config.yml

@@ -1,4 +1,4 @@
-name-template: 'Version $NEXT_PATCH_VERSION - Summary Here🌈'
+name-template: 'Version $NEXT_PATCH_VERSION'
 tag-template: 'v$NEXT_PATCH_VERSION'
 categories:
   - title: '🚀Features'
@@ -10,7 +10,7 @@ categories:
       - 'fix'
       - 'bugfix'
       - 'bug'
-  - title: '🧰Maintenance'
+  - title: 'Maintenance'
     label: 'chore'
 change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
 exclude-labels:

Makefile

@@ -25,7 +25,7 @@ get:
 
 test: get
 	$(GOFMT) ./...
-	$(GOTEST) -race -covermode=atomic ./...
+	$(GOTEST) -count 1 -race -covermode=atomic ./...
 
 coverage: get test
 	$(GOTEST) -race -coverprofile=coverage.txt -covermode=atomic .

README.md

@@ -2,7 +2,7 @@
 [![CircleCI](https://circleci.com/gh/RedisBloom/redisbloom-go.svg?style=svg)](https://circleci.com/gh/RedisBloom/redisbloom-go)
 [![GitHub issues](https://img.shields.io/github/release/RedisBloom/redisbloom-go.svg)](https://github.com/RedisBloom/redisbloom-go/releases/latest)
 [![Codecov](https://codecov.io/gh/RedisBloom/redisbloom-go/branch/master/graph/badge.svg)](https://codecov.io/gh/RedisBloom/redisbloom-go)
-[![GoDoc](https://godoc.org/github.com/RedisBloom/redisbloom-go?status.svg)](https://godoc.org/github.com/RedisBloom/redisbloom-go)
+[![GoDoc](https://godoc.org/github.com/RedisBloom/redisbloom-go?status.svg)](https://pkg.go.dev/github.com/RedisBloom/redisbloom-go)
 [![Go Report Card](https://goreportcard.com/badge/github.com/RedisBloom/redisbloom-go)](https://goreportcard.com/report/github.com/RedisBloom/redisbloom-go)
 
 # redisbloom-go
@@ -32,6 +32,8 @@ docker run -d -p 6379:6379 --name redis-redisbloom redislabs/rebloom:latest
 
 ## Example Code
 
+Make sure to check the full list of examples at [Pkg.go.dev](https://pkg.go.dev/github.com/RedisBloom/redisbloom-go#pkg-examples).
+
 ```go
 package main 
 
@@ -60,6 +62,8 @@ func main() {
 
 ## Supported RedisBloom Commands
 
+Make sure to check the full command reference at [redisbloom.io](https://redisbloom.io).
+
 ### Bloom Filter
 
 | Command | Recommended API and godoc  |

client.go

@@ -12,7 +12,7 @@ import (
 // Client Max Connections
 var maxConns = 500
 
-// Client is an interface to time series redis commands
+// Client is an interface to RedisBloom redis commands
 type Client struct {
 	Pool ConnPool
 	Name string
@@ -21,6 +21,7 @@ type Client struct {
 // NewClient creates a new client connecting to the redis host, and using the given name as key prefix.
 // Addr can be a single host:port pair, or a comma separated list of host:port,host:port...
 // In the case of multiple hosts we create a multi-pool and select connections at random
+// Deprecated: Please use NewClientFromPool() instead
 func NewClient(addr, name string, authPass *string) *Client {
 	addrs := strings.Split(addr, ",")
 	var pool ConnPool

pool.go

@@ -101,5 +101,5 @@ func testOnBorrow(c redis.Conn, t time.Time) (err error) {
 	if time.Since(t) > time.Minute {
 		_, err = c.Do("PING")
 	}
-	return err
+	return
 }