From 6b355b1d6e205807372026b651b83d8f04bbd6cf Mon Sep 17 00:00:00 2001 From: grobolom Date: Sat, 10 Jun 2017 23:53:11 -0400 Subject: [PATCH] Better readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bb12034..783cf06 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Github Team Status Monitor +![current look](https://d2ppvlu71ri8gs.cloudfront.net/items/0b3o3D1U261P3K0l072x/Screen%20Shot%202017-06-10%20at%2011.57.35%20PM.png?v=8f5987e6) + For now, startup is a bit wonky. ``` @@ -9,5 +11,10 @@ npm install npm start ``` +You'll need to define teams yourself (via postman, for example): +![postman](https://d2ppvlu71ri8gs.cloudfront.net/items/1C2L1x3s0N0m2Z103F2z/Screen%20Shot%202017-06-10%20at%2011.48.17%20PM.png?v=f3fd0f05) + +You can enabled the automatic updates by changing `RUN_SCHEDULER` to `True` in `docker-compose.yml`. Alternatively, you may manually hit `0.0.0.0:5000/update` to trigger an update. + Still working on a proper dockerization, and fiddling with auth, which is very -important for this app. +important for this app. \ No newline at end of file