first commit

README.md

@@ -0,0 +1,21 @@
+## Overview
+
+The Ruxit data export API examples demonstrate the export of various parts of Ruxit data, such as
+timeseries, problem feed and infrastructure topology.
+
+### Ruxit data export API documentation
+
+The full API documentation can be found here: 
+https://ruxit.com/help/api-documentation/v1/
+
+####`API key`
+The API key for your Ruxit tenant. You can generate a key by following these steps
+
+1. go to your Ruxit environment: https://{tenant}.live.ruxit.com
+2. Click the burger menu in the right upper corner and select **Integration**
+3. You will see the "API" section; 
+4. Enter a description label and click on **Generate**
+5. copy it and use it in your data export API examples
+
+##License
+This module is provided under BSD-3-Clause license. Please check out the details in the LICENSE.txt