Update README.md

README.md

@@ -1,3 +1,24 @@
 # the-pit
 
-funny little endlessh clone in rust
+funny little endlessh clone in rust
+
+named after the predacon birthplace: https://tfwiki.net/wiki/Pit_(BW)
+
+
+## instructions
+
+### linux
+requirements: docker
+1. copy compose.yml to place you want, read it for important notes
+2. change your ssh port to something other than 22. make sure to unblock the new port in your firewall. then ``pkill sshd`` to kill all old connections and reconnect with new port.
+3. docker compose up -d
+### other oses
+requirements: rust, cargo
+1. build and copy binary to path.
+2. change your ssh port to something other than 22. make sure to unblock the new port in your firewall. then ``pkill sshd`` to kill all old connections and reconnect with new port.
+3. set it up as a service.
+4. start the service with TARPIT_BIND=0.0.0.0:22 as env.
+
+## license
+
+isc