Add quick readmeHEADmaster

1 files changed, 21 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bf76379
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Dockerized Transmission with NordVPN
+
+This was a bit of an experiment to see what could be accomplished. The
+container runs `nordvpnd` so you can do the following to get the container to
+connect to the vpn:
+
+```
+make up
+make enter
+nordvpn connect
+```
+
+This will connect your container to the vpn and you can confirm this with the
+`curl ipinfo.io`. This was my first goal so that I don't constantly lock myself
+out of machines. Docker creates a volume so that nord's data can persist in
+between container restarts.
+
+Now that the container has the networking taken care of, you can run
+`transmission-daemon` inside the container to launch transmission. I've created
+another volume so that transmission will place downloaded files into the
+`downloads` folder.