Add documentation for links.
authorGuo Xiang Tan <tgx_world@hotmail.com>
Wed, 8 Apr 2015 02:52:28 +0000 (10:52 +0800)
committerGuo Xiang Tan <tgx_world@hotmail.com>
Wed, 8 Apr 2015 02:52:28 +0000 (10:52 +0800)
README.md

index dcc0d2930d5409a95daf43917011c659f3e5e024..99730fa4e2ea87e4d159e25c8ba2e9e2e623e96e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -102,6 +102,17 @@ volumes:
 
 Expose a directory inside the host to the container.
 
+#### links:
+```
+links:
+  - link:
+      name: postgres
+      alias: postgres
+```
+
+Links another container to the current container. This will add `--link postgres:postgres`
+to the options when running the container.
+
 ### Upgrading Discourse
 
 The Docker setup gives you multiple upgrade options: