From 467a0afc190f8bb0777ffd8b59fdc9d164a7a3b0 Mon Sep 17 00:00:00 2001
From: Mike Shoup <mike@shoup.io>
Date: Wed, 3 Oct 2018 08:40:59 -0600
Subject: [PATCH] Add more documentation

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

diff --git a/README.md b/README.md
index 83f1ef8..dc1ead1 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,58 @@
 # Temp Gopher
+
+Temp Gopher is a thermostat application written in Go. It is written and tested using a Raspberry Pi, but any hardware platform meeting the requirements will probably work.
+
+## Requirements
+
+You will need a computer (e.g., Raspberry Pi) with the following components:
+
+* A network connection
+* DS18B120, 1-wire temperature sensors
+* GPIO pins
+* Relays for powering on/off your equipment hooked up to the GPIO pins
+
+## Installation
+
+You can build on a Raspberry Pi, however, it can take a long time! I recommend building on a separate computer with a bit more processing power.
+
+```
+go get gitea.shoup.io/mike/temp-gopher
+cd $GOPATH/src/gitea.shoup.io/mike/temp-gopher
+GOOS=linux GOARCH=arm GOARM=6 go build -a -ldflags '-w -s -extldflags "-static"'
+scp temp-gopher <raspberrypi>:~/somepath
+```
+
+## Configuration
+
+Create a `config.yml` file like this:
+
+```
+sensors:
+- id: 28-000008083108 # Id of the DS18b120 sensor
+  alias: fermenter # An alias for the sensor
+  hightemp: 8 # Maximum temperature you want the sensor to read
+  lowtemp: 4 # Minimum tempearture you want the sensor to read
+  heatgpio: 5 # GPIO pin the heater is hooked into
+  heatinvert: false # Probably false. If true, will set pin to High to turn the heater off
+  heatminutes: 1 # Number of minutes below the minimum before the heater turns on
+  coolgpio: 17 # GPIO pin the cooler is hooked into
+  coolinvert: false # Probably false. If true, will set pin to High to turn the cooler off
+  coolminutes: 10 # Number of minutes below the minimum before the cooler turns on
+  verbose: false # If true, outputs the current status at every read, approx once per second
+```
+
+## Running
+
+You can run it directly in the comment line like:
+
+```
+./temp-gopher -c config.yml run
+```
+
+You can run it in the background using `nohup`:
+
+```
+nohup ./temp-gopher -c config.yml run &
+```
+
+Or use `systemctl` or some other process supervisor to run it.