From b8d3b1520605cbbecc5a4756524bd9661903b7a0 Mon Sep 17 00:00:00 2001 From: Gyu-Ho Lee Date: Wed, 30 Mar 2016 09:33:13 -0700 Subject: [PATCH] *: document client package vendoring guide --- client/README.md | 5 +++++ clientv3/README.md | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/client/README.md b/client/README.md index 2b35827d0..16f7f9d19 100644 --- a/client/README.md +++ b/client/README.md @@ -4,6 +4,11 @@ etcd/client is the Go client library for etcd. [![GoDoc](https://godoc.org/github.com/coreos/etcd/client?status.png)](https://godoc.org/github.com/coreos/etcd/client) +etcd uses go's `vendor` directory to manage external dependencies. If `client` is imported +outside of etcd, simply copy `client` to the `vendor` directory or use tools like godep to +manage your own dependency, as in [vendor directories](https://golang.org/cmd/go/#hdr-Vendor_Directories). +For more detail, please read [Go vendor design](https://golang.org/s/go15vendor). + ## Install ```bash diff --git a/clientv3/README.md b/clientv3/README.md index 581329465..e67d68a11 100644 --- a/clientv3/README.md +++ b/clientv3/README.md @@ -40,6 +40,11 @@ if err != nil { // use the response ``` +etcd uses go's `vendor` directory to manage external dependencies. If `clientv3` is imported +outside of etcd, simply copy `clientv3` to the `vendor` directory or use tools like godep to +manage your own dependency, as in [vendor directories](https://golang.org/cmd/go/#hdr-Vendor_Directories). +For more detail, please read [Go vendor design](https://golang.org/s/go15vendor). + ## Error Handling etcd client returns 2 types of errors: