[add] initial commit

README.md

@@ -0,0 +1,32 @@
+<h1 align="center">[WIP] Gelvin</h1>
+
+<h4 align="center">
+	REST API for IoT Sensors.
+</h4>
+
+`Gelvin` is a simple REST-API for IoT Sensors. Currently work in progess. API is subject to change.
+
+<p align="center">
+    <strong>
+        <a href="https://api.pdev.dev/gelvin/measurements/2">My Office Temp (°C)</a>
+        • <a href="#rest-api">Rest API</a> 
+	</strong>
+</p>
+
+## REST API
+
+The following is a quick overview of the available commands.
+
+### Sensors
+
+* [`GET /sensors`]() - Retrieve all sensors information
+* [`GET /sensors/{SensorID}`]() - Retrieve sensor information
+* [`POST /sensors`]() - Create or update a sensor and retrieve `SensorID`
+
+
+### Measurements
+
+* [`GET /measurements`]() - Retrieve all sensors measurements
+* [`GET /measurements/{SensorID}`]() - Retrieve sensor measurements
+* [`POST /measurements`]() - Add measurement (payload needs to include `SensorID`)
+* [`POST /measurements/{SensorID}`]() - Add measurement to sensor