Skip to content

Commit 5de9a60

Browse files
committed
Update README
1 parent cb7c932 commit 5de9a60

File tree

1 file changed

+3
-15
lines changed

1 file changed

+3
-15
lines changed

README.md

+3-15
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,19 @@
1-
# Aerospike Go Client
1+
# Aerospike Go Client v5
22

33
[![Aerospike Client Go](https://goreportcard.com/badge/github.com/aerospike/aerospike-client-go)](https://goreportcard.com/report/github.com/aerospike/aerospike-client-go)
44
[![Build Status](https://travis-ci.org/aerospike/aerospike-client-go.svg?branch=master)](https://travis-ci.org/aerospike/aerospike-client-go)
55
[![Godoc](https://godoc.org/github.com/aerospike/aerospike-client-go?status.svg)](https://pkg.go.dev/github.com/aerospike/aerospike-client-go)
66

77
An Aerospike library for Go.
88

9-
This library is compatible with Go 1.9+ and supports the following operating systems: Linux, Mac OS X (Windows builds are possible, but untested).
9+
This library is compatible with Go 1.13+ and supports the following operating systems: Linux, Mac OS X (Windows builds are possible, but untested).
1010

1111
Up-to-date documentation is available in the [![Godoc](https://godoc.org/github.com/aerospike/aerospike-client-go?status.svg)](https://pkg.go.dev/github.com/aerospike/aerospike-client-go).
1212

1313
You can refer to the test files for idiomatic use cases.
1414

1515
Please refer to [`CHANGELOG.md`](CHANGELOG.md) for release notes, or if you encounter breaking changes.
1616

17-
## Notice:
18-
19-
We have released the Go Client v2, with some breaking API changes. Most changes are minor, and can be fixed with relative ease.
20-
21-
The only major issue is that the behavior of the client when a key does not exist has changed.
22-
23-
It used to return no error, but a `nil` `Record.Bins`. Now it returns `ErrKeyNotFound` error.
24-
25-
This is a significant changes, and you should search your code for all instances of `Bins == nil` and adapt the code accordingly.
26-
27-
Please refer to the [`CHANGELOG.md`](CHANGELOG.md) for details.
28-
2917
- [Usage](#Usage)
3018
- [Prerequisites](#Prerequisites)
3119
- [Installation](#Installation)
@@ -116,7 +104,7 @@ Supported operating systems:
116104
<a name="Installation"></a>
117105
## Installation
118106

119-
1. Install Go 1.9+ and setup your environment as [Documented](http://golang.org/doc/code.html#GOPATH) here.
107+
1. Install Go 1.13+ and setup your environment as [Documented](http://golang.org/doc/code.html#GOPATH) here.
120108
2. Get the client in your ```GOPATH``` : ```go get github.com/aerospike/aerospike-client-go```
121109
* To update the client library: ```go get -u github.com/aerospike/aerospike-client-go```
122110

0 commit comments

Comments
 (0)