summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorschneefux <schneefux+commit@schneefux.xyz>2018-05-07 09:59:23 +0200
committerschneefux <schneefux+commit@schneefux.xyz>2018-05-07 09:59:23 +0200
commit9f12ba674bb824627ceb648e79a2fa7065a1e51d (patch)
tree93d76e6d2864f24ce939e570a1ffe41eec889241 /README
parente2f6fd89c18f943969ffa1abf75d5e074152fb4d (diff)
downloadbrokentalents-9f12ba674bb824627ceb648e79a2fa7065a1e51d.tar.gz
brokentalents-9f12ba674bb824627ceb648e79a2fa7065a1e51d.zip
make markdown readme
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 0 insertions, 18 deletions
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.