From b3cc97d71fa2b1d95c28a7e9b12c19c9c680bca2 Mon Sep 17 00:00:00 2001
From: Seth Vargo <sethvargo@gmail.com>
Date: Thu, 23 Apr 2015 11:45:37 -0400
Subject: [PATCH] Add docs

---
 api/client.go | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/api/client.go b/api/client.go
index df25cd6e30..28d9c231a2 100644
--- a/api/client.go
+++ b/api/client.go
@@ -34,6 +34,9 @@ type Config struct {
 
 // DefaultConfig returns a default configuration for the client. It is
 // safe to modify the return value of this function.
+//
+// The default Address is https://127.0.0.1:8200, but this can be overridden by
+// setting the `VAULT_HTTP_ADDR` environment variable.
 func DefaultConfig() *Config {
 	config := &Config{
 		Address:    "https://127.0.0.1:8200",
@@ -55,6 +58,10 @@ type Client struct {
 }
 
 // NewClient returns a new client for the given configuration.
+//
+// If the environment variable `VAULT_TOKEN` is present, the token will be
+// automatically added to the client. Otherwise, you must manually call
+// `SetToken()`.
 func NewClient(c *Config) (*Client, error) {
 	u, err := url.Parse(c.Address)
 	if err != nil {