From 5f819c467b6ad8620b2bfc002fb37dc7c25c6bdf Mon Sep 17 00:00:00 2001
From: kolaente <k@knt.li>
Date: Sat, 2 Oct 2021 13:47:47 +0200
Subject: [PATCH] Add README

---
 .gitignore |  2 +-
 README.md  | 25 +++++++++++++++++++++++++
 2 files changed, 26 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index 4bf81fe..a86ddab 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,2 @@
 .idea/
-1-wire-temp
+1-wire-temp*
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2af174c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# 1-wire temperature metrics with prometheus
+
+This is a simple package providing the temperature of a 1-wire sensor such as the DH1820 as prometheus metrics. It reads
+the `w1_slave` file at `/sys/bus/w1/devices/<sensor>`, parses it and provides the read temperature at a webserver
+running on port 2112 at `/metrics`.
+
+## Usage
+
+Simply run the compiled program and provide the id of the sensor with the `-s` flag. The id is the name of the folder at
+`/sys/bus/w1/devices/` containing the `w1_slave` file.
+
+## Building
+
+To build this package for the raspberry pi zero:
+
+```bash
+GOOS=linux GOARCH=arm GOARM=6 go build -o 1-wire-temp-arm
+```
+
+To build for all other Pi's:
+
+```bash
+GOOS=linux GOARCH=arm GOARM=7 go build -o 1-wire-temp-arm
+```
+