Add license, readme, etc

1 files changed, 53 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..afc583c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,53 @@
+# ruuvitag-upload
+
+A tool for collecting a set of ruuvitag sensor measurements
+and uploading them for further processing.
+
+The measurements are formatted as JSON with the following
+structure
+
+    {
+        \"<ALIAS>\": {
+            \"address\": \"XX:XX:XX:XX:XX:XX\",
+            \"timestamp\": <seconds since unix epoch>,
+            \"humidity\": <0-100%>,
+            \"pressure\": <kPa>,
+            \"temperature\": <Celcius>,
+            \"battery_potential\": <volts>
+        },
+        ...
+    }
+
+where ALIAS will either be the address of the sensor, or
+an alias that you can define.
+
+## USAGE
+
+    ruuvitag-upload [--url=URL] <sensor>...
+    ruuvitag-upload -h | --help
+    ruuvitag-upload --version
+
+## ARGUMENTS
+
+    <sensor>...
+
+        A sensor address and optionally a human-readable
+        alias. You can either specify the address as
+        XX:XX:XX:XX:XX:XX or you can attach a human-
+        readable alias to the address
+        XX:XX:XX:XX:XX:XX=mysensor.
+
+## OPTIONS
+
+    -u URL, --url=URL
+
+        Where the measurements are uploaded to. If you don't
+        specify this, the measurements are written to stdout.
+
+    -h, --help
+
+        Show this message.
+
+    --version
+
+        Show the version number.