From b00fb970a0e0214f2b0f7cd6873615145ebddd6a Mon Sep 17 00:00:00 2001 From: Radek Stepan Date: Sun, 29 Sep 2013 23:22:20 +0100 Subject: [PATCH] docs --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a881c7c..9f41cf7 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,35 @@ #GitHub Burndown Chart -Displays a burndown chart from a set of GitHub issues in the current milestone; all client side. +Displays a burndown chart from a set of GitHub issues in the current milestone. [ ![Codeship Status for radekstepan/github-burndown-chart](https://www.codeship.io/projects/d69f4420-e5b0-0130-bbae-1632ddfb80f8/status?branch=rework)](https://www.codeship.io/projects/5855) +##Features + +1. Client side. +1. Private repos. +1. Off days. +1. Trend line. + ![image](https://raw.github.com/radekstepan/github-burndown-chart/master/example.png) ##Quickstart -1. Choose a repo that you want to display burndown chart for. -1. Make sure this repo has some issues assigned to a milestone. -1. Put some labels on the issues looking like this: `size 1`, `size 3` etc. -1. Close some of them labeled issues. +1. Choose a **repo** that you want to display burndown chart for. +1. Make sure this repo has some **issues** assigned to a **milestone**. +1. Put some **labels** on the issues looking like this: `size 1`, `size 3` etc. +1. **Close** some of them labeled issues. 1. Visit [http://radekstepan.github.io/github-burndown-chart](http://radekstepan.github.io/github-burndown-chart) following the instructions there. ##Configuration There are three modes of operation balancing between usability & security: -1. You can just serve the `public` directory using a static file server or GitHub Pages. No config needed, just serve the app and point to your repo in the browser, e.g.: `http://127.0.0.1:8000/#!/radekstepan/disposable`. You are rate limited to the tune of [60 requests per hour](http://developer.github.com/v3/#rate-limiting). -1. As before but now you want to use your [GitHub OAuth2 API Token](http://developer.github.com/v3/#authentication) in the config. This will require you to specify the token in the `config.json` file as outlined below. -1. You find it preposterous to share your token with the world. In this case you will need to serve the app using the [Proxy Mode](#proxy-mode). Your token will be scrubbed from the config file and all requests be routed through a proxy. +1. **Static Mode**: You can just serve the `public` directory using a static file server or GitHub Pages. No config needed, just serve the app and point to your repo in the browser, e.g.: `http://127.0.0.1:8000/#!/radekstepan/disposable`. You are rate limited to the tune of [60 requests per hour](http://developer.github.com/v3/#rate-limiting). +1. **Static Mode (Public Token)**: As before but now you want to use your [GitHub OAuth2 API Token](http://developer.github.com/v3/#authentication) in the config. This will require you to specify the token in the `config.json` file as outlined below. +1. **Proxy Mode (Private Token)**: You find it preposterous to share your token with the world. In this case you will need to serve the app using the [Proxy Mode](#proxy-mode). Your token will be scrubbed from the config file and all requests be routed through a proxy. -None of the following fields or the file, `config.json` itself are required: +All of the following fields are defined in `config.json` and none of them, including the file itself, are required: ###Size Label