Update the root readme

Geotab · Jan 22, 2018 · 65d880d · 65d880d
1 parent a633f0c
commit 65d880d
Show file tree

Hide file tree

Showing 2 changed files with 248 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,167 @@
 # sdk-addin-samples [![Build Status](https://travis-ci.org/Geotab/sdk-addin-samples.svg?branch=master)](https://travis-ci.org/Geotab/sdk-addin-samples)
-A collection of samples demonstrating how build MyGeotab and Geotab Drive add-ins.
+
+> A collection of samples demonstrating how build MyGeotab and Geotab Drive add-ins.
+
+## How to run the examples
+
+In order to run these examples, you can clone this repo, go into each of the examples and follow the instructions in the README.md file.
+
+Alternativly, you can install the add-ins on your production database individually using the install configuration as described in each subfolder README.md or to install all the examples under one navigation section in your demo database use the installation settings below.
+
+```json
+{
+    "name": "SDK Add-In Samples",
+    "supportEmail": "support@geotab.com",
+    "version": "1.0.0",
+    "items": [{
+        "path": "/",
+        "menuId": "sdkAddinsLink",
+        "menuName": {
+            "en": "Add-In Samples",
+        },
+        "icon": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/icon.svg"
+    }, {
+        "name": "Heat Map",
+        "supportEmail": "support@geotab.com",
+        "version": "1.0.0",
+        "items": [{
+            "url": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-heatmap/dist/heatmap.html",
+            "path": "sdkAddinsLink/",
+            "menuName": {
+                "en": "Heat Map"
+            },
+            "icon": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-heatmap/dist/images/icon.svg"
+        }
+        ]
+    }, {
+        "name": "Proximity",
+        "supportEmail": "support@geotab.com",
+        "version": "1.0.0",
+        "items": [{
+            "url": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-proximity/dist/proximity.html",
+            "path": "sdkAddinsLink/",
+            "menuName": {
+                "en": "Proximity"
+            },
+            "icon": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-proximity/dist/images/icon.svg"
+        }
+        ]
+    }, {
+        "name": "Trips Timeline",
+        "supportEmail": "support@geotab.com",
+        "version": "1.0.0",
+        "items": [{
+            "url": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-trips-timeline/dist/tripsTimeline.html",
+            "path": "sdkAddinsLink/",
+            "menuName": {
+                "en": "Trips Timeline"
+            },
+            "icon": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-trips-timeline/dist/images/icon.svg"
+        }
+        ]
+    }, {
+        "name": "Import KML Zones",
+        "supportEmail": "support@geotab.com",
+        "version": "1.0.0",
+        "items": [{
+            "url": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-import-kml-zones/dist/importKmlZones.html",
+            "path": "sdkAddinsLink/",
+            "menuName": {
+                "en": "Import KML Zones"
+            },
+            "icon": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-import-kml-zones/dist/images/icon.svg"
+        }
+        ]
+    }, {
+        "name": "Start Stop",
+        "supportEmail": "support@geotab.com",
+        "version": "1.0.0",
+        "items": [{
+            "url": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-start-stop/dist/startStop.html",
+            "path": "sdkAddinsLink/",
+            "menuName": {
+                "en": "Start-Stop Savings"
+            },
+            "icon": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-start-stop/dist/images/icon.svg"
+        }
+        ]
+    }, {
+        "name": "IOX Output",
+        "supportEmail": "support@geotab.com",
+        "version": "1.0.0",
+        "items": [{
+            "url": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-iox-output/dist/ioxOutput.html",
+            "path": "sdkAddinsLink/",
+            "menuName": {
+                "en": "IOX Output"
+            },
+            "icon": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-iox-output/dist/images/icon.svg"
+        }
+        ]
+    }, {
+        "name": "Engine Data Button",
+        "supportEmail": "support@geotab.com",
+        "version": "1.0.0",
+        "items": [{
+            "page": "device",
+            "click": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-engine-data-button/dist/scripts/engineDataButton.js",
+            "buttonName": {
+                "en": "Engine Data Profile",
+                "fr": "Profil des données-moteur",
+                "es": "Perfil de datos de motor",
+                "ja": "エンジンデータプロフィール"
+            },
+            "icon": "https://cdn.rawgit.com/Geotab/sdk-addin-samples/master/addin-engine-data-button/dist/images/icon.svg"
+        }
+        ]
+    }
+    ]
+}
+
+```
+
+## MyGeotab Page Examples
+
+### Heatmap
+
+This add-in is visualizes the location history of a vehicle by displaying areas of "heat" on a map corresponding to the frequency in which they were at a certain location using [leaflet](http://leafletjs.com/) and [Leaflet.heat](https://github.com/Leaflet/Leaflet.heat).
+
+[Source](https://github.com/Geotab/sdk-addin-samples/tree/master/addin-heatmap)
+
+### Proximity
+
+This add-in demonstrates a visual report for determining whether a vehicle has been to or near a particular location in a given date range using [leaflet](http://leafletjs.com/).
+
+[Source](https://github.com/Geotab/sdk-addin-samples/tree/master/addin-proximity)
+
+## Trips Timeline
+
+This add-in demonstrates a compact visualization of the times vehicles made their trips throughout the day using [vis.js](http://visjs.org/).
+
+[Source](https://github.com/Geotab/sdk-addin-samples/tree/master/addin-trips-timeline)
+
+### Start Stop Savings
+
+This add-in demonstrates an informational display add-in which provides an estimate of fuel savings for vehicles which have stop-start systems.
+
+[Source](https://github.com/Geotab/sdk-addin-samples/tree/master/addin-start-stop)
+
+### Import KML Zones
+
+This example demonstrates an add-in which parses a [KML file](https://developers.google.com/kml/documentation/) and imports to MyGeotab as Zones.
+
+[Source](https://github.com/Geotab/sdk-addin-samples/tree/master/addin-import-kml-zones)
+
+### IOX Output
+
+This example demonstrates how to send a message to a device, turning the IOX on or off.
+
+[Source](https://github.com/Geotab/sdk-addin-samples/tree/master/addin-iox-output)
+
+## MyGeotab Button Examples
+
+### Engine Data Button
+
+This example demonstrates an add-in button on the vehicle page which pulls the currently selected vehicle ID from state. The ID to redirect to the engine data profile page to examine the recorded engine speed, voltage and fuel used.
+
+[Source](https://github.com/Geotab/sdk-addin-samples/tree/master/addin-engine-data-button)
diff --git a/icon.svg b/icon.svg