From cb2b96f00d0489d7f5907b5e7c4e62ce28a3be16 Mon Sep 17 00:00:00 2001
From: jarlave <jarlave@users.noreply.github.com>
Date: Sun, 31 Mar 2019 16:43:21 +0200
Subject: [PATCH] Update README.md

---
 README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 57 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 961b094..a378203 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,53 @@
+Docker image to setup a Tor relay with [nyx](https://nyx.torproject.org/) monitoring
+==============================================
+![Docker Build Status](https://img.shields.io/docker/cloud/build/jarlave/tor-relay-nyx.svg)
+![Docker Image Size](https://img.shields.io/microbadger/image-size/jarlave/tor-relay-nyx.svg)
+
+### Middle relay
+
+```bash
+docker run -d \
+	--restart always \
+	-v tor-relay-data:/home/tor/data:rw
+	-v /etc/localtime:/etc/localtime:ro \
+	-p 9001:9001 \
+	-e RELAY_NICKNAME='ChangeMe' \
+	-e CONTACT_EMAIL='tor[at]example[dot]com' \
+	--name tor-relay \
+	jarlave/tor-relay-nyx
+```
+
+### Bridge relay
+
+
+```bash
+docker run -d \
+	--restart always \
+	-v tor-relay-data:/home/tor/data:rw
+	-v /etc/localtime:/etc/localtime:ro \
+	-p 9001:9001 \
+	-e RELAY_TYPE='bridge' \
+	-e RELAY_NICKNAME='ChangeMe' \
+	-e CONTACT_EMAIL='tor[at]example[dot]com' \
+	--name tor-relay \
+	jarlave/tor-relay-nyx
+```
+
+### Exit relay
+
+```bash
+docker run -d \
+	--restart always \
+	-v tor-relay-data:/home/tor/data:rw
+	-v /etc/localtime:/etc/localtime:ro \
+	-p 9001:9001 \
+	-e RELAY_TYPE='exit' \
+	-e RELAY_NICKNAME='ChangeMe' \
+	-e CONTACT_EMAIL='tor[at]example[dot]com' \
+	--name tor-relay \
+	jarlave/tor-relay-nyx
+```
+
  ### Environment variables
 
 | Name                         | Description                                                                  | Default value |
@@ -13,4 +63,10 @@
 | **RELAY_DIRPORT**            | Default port used for directory (DirPort)                                    | 9030          |
 | **RELAY_CTRLPORT**           | Default port used for control interface (ControlPort)                        | 9051          |
 | **RELAY_ACCOUNTING_MAX**     | Default threshold for sent and recieve (AccountingMax)                       | 1 GBytes      |
-| **RELAY_ACCOUNTING_START**   | threshold rest (AccountingStart)                                             | day 00:00     |
\ No newline at end of file
+| **RELAY_ACCOUNTING_START**   | threshold rest (AccountingStart)                                             | day 00:00     |
+
+### Open nyx
+
+```bash
+docker exec -it tor-relay nyx
+```