Add a user/developer friendly README

StatIndex/README.md

@@ -0,0 +1,61 @@
+# Trust Project Stat Index
+
+> One paragraph description about what it does from a non-technical point of view
+
+Some more context, background etc.
+
+# Install
+
+N/A
+
+```bash
+$ install.package('...')
+# ...
+```
+
+# Use
+
+## Command line
+
+N/A
+
+```bash
+# ...
+```
+
+## API
+
+N/A
+
+```r
+# ...
+```
+
+# Stat Index Datapoints
+
+| Key        | Type       | Comment          |
+| ---        | ---        | ---              |
+| N/A        | N/A        |                  |
+
+Sample response:
+
+```json
+{
+  "key-name": [
+    { ...: ... },
+    { ...: ... }
+  ]
+}
+```
+
+# Contribute
+
+## Update the stats dictionnary
+
+N/A
+
+# License / Credits
+
+N/A
+
+> Choose a license (MIT, Apache-2.0 etc.)