feat: project bootstrap

README.md

@@ -1,2 +1,27 @@
 # tor-relay-docker
-Lightweight TOR relay image.
+
+Lightweight TOR relay image, based on the ["lsiobase/alpine" Docker image](https://hub.docker.com/r/lsiobase/alpine) provided by https://linuxserver.io.
+
+## Usage
+
+```bash
+docker run \
+  # -d \
+  --name tor-relay \
+  -e TOR_ORPort=9001 \
+  -e TZ=Europe/London \
+  -e TYPE= \
+  -p 9001:9001 \
+  # -u $(id -u)/$(id -g) \
+  --restart always \
+  ilshidur/tor-relay
+```
+
+## Configuration
+
+The configuration is stored in a `/etc/tor/torrc` file.
+Everyline can be changed using environment variables as described below :
+
+`TOR_<configuration>=<value>` will uncomment the first line starting with `<configuration>` and set its value to `<value>`.
+
+*Example : setting `TOR_ORPort` to `9002` will change the line `#ORPort 9001` to `ORPort 9002`.*