Merge pull request #132 from foliea/auth-config

add docs for authconfig base64 encoded key
apocas · Apr 18, 2015 · fddd2ec · fddd2ec
2 parents 8e2f87b + cdf4bdb
commit fddd2ec
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -212,6 +212,14 @@ docker.pull('tag', {'authconfig': auth}, function (err, stream) {
   //...
 });
 ```
+
+If you already have a base64 encoded auth object, you can use it directly:
+
+```js
+var auth = { key: 'yJ1J2ZXJhZGRyZXNzIjoitZSI6Im4OCIsImF1dGgiOiIiLCJlbWFpbCI6ImZvbGllLmFkcmc2VybmF0iLCJzZX5jb2aHR0cHM6Ly9pbmRleC5kb2NrZXIuaW8vdZvbGllYSIsInBhc3N3b3JkIjoiRGVjZW1icmUjEvIn0=' }
+```
+
+
 ## Helper functions
 
 * `followProgress` - allows to fire a callback only in the end of a stream based process. (build, pull, ...)