From 4b93013f9c37944e4ea0b68a38c4dc8557578a67 Mon Sep 17 00:00:00 2001 From: Thomas Parisot Date: Wed, 24 Aug 2016 17:00:29 +0100 Subject: [PATCH] README skeleton --- StatIndex/README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 StatIndex/README.md diff --git a/StatIndex/README.md b/StatIndex/README.md new file mode 100644 index 0000000..f6810f8 --- /dev/null +++ b/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.)