Browse Source

Merge pull request #4905 from gyuho/vendor_doc

*: document client package vendoring guide
Gyu-Ho Lee 9 years ago
parent
commit
1bee31a3bb
2 changed files with 10 additions and 0 deletions
  1. 5 0
      client/README.md
  2. 5 0
      clientv3/README.md

+ 5 - 0
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

+ 5 - 0
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: