better documentation and info; refs #45

This commit is contained in:
Radek Stepan 2014-07-30 09:55:46 +01:00
parent 8e83f986d1
commit a012a326c8
6 changed files with 24 additions and 10 deletions

View File

@ -1,8 +1,6 @@
#GitHub Burndown Chart [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/) #GitHub Burndown Chart [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)
**The original app got completely rewritten, see [notes](#rewrite), thank you.** Displays a burndown chart from a set of GitHub issues in a milestone.
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)](https://www.codeship.io/projects/5855) [ ![Codeship Status for radekstepan/github-burndown-chart](https://www.codeship.io/projects/d69f4420-e5b0-0130-bbae-1632ddfb80f8/status)](https://www.codeship.io/projects/5855)
@ -101,7 +99,19 @@ $ make install
$ make build $ make build
``` ```
We are using the [Bower](http://bower.io/) package manager and [Grunt](http://gruntjs.com/) task runner. When you are done developing, you may want to create a minified build:
```bash
$ make minify
```
We are using the [Bower](http://bower.io/) package manager and [Grunt](http://gruntjs.com/) task runner. To [install Bower](http://bower.io/#install-bower) and [install Grunt](http://gruntjs.com/installing-grunt) run the following commands:
```bash
$ sudo npm install bower -g
$ sudo npm install grunt -g
$ sudo npm install grunt-cli -g
```
##Publish It ##Publish It
@ -132,4 +142,4 @@ If you would like to use the original app, please refer to the `original` branch
##Thanks ##Thanks
Thank you for using the app and your feedback/comments are very much welcome. Radek Thank you for using the app and your feedback/comments are very much welcome. Radek

View File

@ -21299,7 +21299,7 @@ require.alias("superagent/lib/client.js", "superagent/index.js");if (typeof expo
} }
(function() { (function() {
(function() { (function() {
__out.push('<div class="box info">\n <h2>GitHub Burndown Chart</h2>\n <p>Use your browser\'s location hash to specify a <strong>repo</strong>: <a href="#!/radekstepan/disposable">#!/radekstepan/disposable</a>.</p>\n <p>You can choose a specific <strong>milestone</strong> like so: <a href="#!/radekstepan/disposable/1">#!/radekstepan/disposable/1</a>.</p>\n</div>'); __out.push('<div class="box info">\n <h2>GitHub Burndown Chart</h2>\n \n <p>Use your browser\'s location hash to specify a <strong>repo</strong>: <a href="#!/radekstepan/disposable">#!/radekstepan/disposable</a>.</p>\n \n <p>You can choose a specific <strong>milestone</strong> by its <em>number</em>: <a href="#!/radekstepan/disposable/1">#!/radekstepan/disposable/1</a>.</p>\n\n <p>To get the milestone <em>number</em>, fetch all your milestones using <a href="https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository" title="GitHub API docs">GitHub API</a>.</p>\n</div>');
}).call(this); }).call(this);

File diff suppressed because one or more lines are too long

View File

@ -1116,7 +1116,7 @@
} }
(function() { (function() {
(function() { (function() {
__out.push('<div class="box info">\n <h2>GitHub Burndown Chart</h2>\n <p>Use your browser\'s location hash to specify a <strong>repo</strong>: <a href="#!/radekstepan/disposable">#!/radekstepan/disposable</a>.</p>\n <p>You can choose a specific <strong>milestone</strong> like so: <a href="#!/radekstepan/disposable/1">#!/radekstepan/disposable/1</a>.</p>\n</div>'); __out.push('<div class="box info">\n <h2>GitHub Burndown Chart</h2>\n \n <p>Use your browser\'s location hash to specify a <strong>repo</strong>: <a href="#!/radekstepan/disposable">#!/radekstepan/disposable</a>.</p>\n \n <p>You can choose a specific <strong>milestone</strong> by its <em>number</em>: <a href="#!/radekstepan/disposable/1">#!/radekstepan/disposable/1</a>.</p>\n\n <p>To get the milestone <em>number</em>, fetch all your milestones using <a href="https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository" title="GitHub API docs">GitHub API</a>.</p>\n</div>');
}).call(this); }).call(this);

2
build/app.min.js vendored

File diff suppressed because one or more lines are too long

View File

@ -1,5 +1,9 @@
<div class="box info"> <div class="box info">
<h2>GitHub Burndown Chart</h2> <h2>GitHub Burndown Chart</h2>
<p>Use your browser's location hash to specify a <strong>repo</strong>: <a href="#!/radekstepan/disposable">#!/radekstepan/disposable</a>.</p> <p>Use your browser's location hash to specify a <strong>repo</strong>: <a href="#!/radekstepan/disposable">#!/radekstepan/disposable</a>.</p>
<p>You can choose a specific <strong>milestone</strong> like so: <a href="#!/radekstepan/disposable/1">#!/radekstepan/disposable/1</a>.</p>
<p>You can choose a specific <strong>milestone</strong> by its <em>number</em>: <a href="#!/radekstepan/disposable/1">#!/radekstepan/disposable/1</a>.</p>
<p>To get the milestone <em>number</em>, fetch all your milestones using <a href="https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository" title="GitHub API docs">GitHub API</a>.</p>
</div> </div>