From 1cb0762d8b54d1f4ca6f5b4dbcc08d39b8538773 Mon Sep 17 00:00:00 2001
From: Christophe Mehay <cmehay@student.42.fr>
Date: Mon, 21 Sep 2015 17:42:48 +0200
Subject: [PATCH] quick readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..57f010f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+h1. docker-tor-hidden-service
+
+Create a tor hidden service with a link
+
+```
+$ # run a container with an network application
+$ docker run -d --name hello_world tutum/hello_world
+$ # and just link it to this container
+$ docker run -ti --link hello_world goldy/tor-hidden-service
+```
+
+The .onion url is displayed to stdout at startup.
+
+To keep onion keys, just mount volume `/var/lib/tor/hidden_service/`
+
+```
+$ docker run -ti --link something --volume /path/to/keys:/var/lib/tor/hidden_service/ goldy/tor-hidden-service
+```