From 9f12ba674bb824627ceb648e79a2fa7065a1e51d Mon Sep 17 00:00:00 2001 From: schneefux Date: Mon, 7 May 2018 09:59:23 +0200 Subject: make markdown readme --- README | 18 ------------------ README.md | 18 ++++++++++++++++++ 2 files changed, 18 insertions(+), 18 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index bd24adc..0000000 --- a/README +++ /dev/null @@ -1,18 +0,0 @@ -# brokentalents.fun - -## Setup - - * `npm install` - * create backend/secret.js as `module.exports.apikey = 'yourapikey';` or export the env var `API_KEY=""` - -## Updating the data - -`npm run backend` - -## Overview - -![backend flowchart](assets/backend-flow.png) - -The `/matches` endpoint is called in equidistant intervals for a small set of matches. An hour of each set is aggregated and stored in a timestamped json. All timestamped jsons are aggregated and generate the output report json. - -The code was written with [Ramda](https://ramdajs.com) as an excercise in functional programming with JavaScript. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bd24adc --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# brokentalents.fun + +## Setup + + * `npm install` + * create backend/secret.js as `module.exports.apikey = 'yourapikey';` or export the env var `API_KEY=""` + +## Updating the data + +`npm run backend` + +## Overview + +![backend flowchart](assets/backend-flow.png) + +The `/matches` endpoint is called in equidistant intervals for a small set of matches. An hour of each set is aggregated and stored in a timestamped json. All timestamped jsons are aggregated and generate the output report json. + +The code was written with [Ramda](https://ramdajs.com) as an excercise in functional programming with JavaScript. -- cgit v1.3.1