Skip to content

Commit

Permalink
Update Readme for Install etcd client v3 more visibility etcd-io#13108
Browse files Browse the repository at this point in the history
There are many developers on the web, confused by how to install etcd v3 for the development of go project.

A number of similar errors were encountered, as follows:
etcd-io#13108

```
➜  ~ go version
go version go1.16.5 darwin/amd64

➜  ~  go get go.etcd.io/etcd/clientv3

go: downloading golang.org/x/net v0.0.0-20201021035429-f5854403a974
# github.com/coreos/etcd/clientv3/balancer/picker
go/pkg/mod/github.com/coreos/[email protected]+incompatible/clientv3/balancer/picker/err.go:37:44: undefined: balancer.PickOptions
go/pkg/mod/github.com/coreos/[email protected]+incompatible/clientv3/balancer/picker/roundrobin_balanced.go:55:54: undefined: balancer.PickOptions
# github.com/coreos/etcd/clientv3/balancer/resolver/endpoint
go/pkg/mod/github.com/coreos/[email protected]+incompatible/clientv3/balancer/resolver/endpoint/endpoint.go:114:78: undefined: resolver.BuildOption
go/pkg/mod/github.com/coreos/[email protected]+incompatible/clientv3/balancer/resolver/endpoint/endpoint.go:182:31: undefined: resolver.ResolveNowOption
```

There are many examples of confusion here:

- etcd-io#12577
- etcd-io#12181
- etcd-io#12068
- etcd-io#11931
......

So, As suggested by  @lilic , I submitted Readme update.
  • Loading branch information
forging2012 authored Jun 17, 2021
1 parent 09392c5 commit 3adb2bd
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ go get go.etcd.io/etcd/client/v3
```

`etcd/clientv3` is the official Go etcd client for v3. Read more:[etcd client v3 install](https://github.com/etcd-io/etcd/tree/main/client/v3#install)

Notes to resolve dependency and compatibility issues for go modules: [#13108](https://github.com/etcd-io/etcd/issues/13108)

### Next steps
Expand Down

0 comments on commit 3adb2bd

Please sign in to comment.