Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kneath committed May 4, 2009
1 parent 5e403b5 commit 6747f02
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.markdown
Expand Up @@ -2,8 +2,10 @@

Burndown is a little app to help you keep tabs on your Lighthouse projects. It shows you how many tickets you open and close every day, along with a chart showing the progress along a milestone.

Still in progress.

## Deployment

If you want to make your life easy, go ahead and just deploy to [Heroku](http://heroku.com). Burndown is ready to go for a deployment to Heroku, cron jobs and all! If you want to set it up on your own, you'll need to make sure the tasks in `lib/tasks/cron.rake` get run once a day.
If you want to make your life easy, go ahead and just deploy to [Heroku](http://heroku.com). Burndown is ready to go for a deployment to Heroku, cron jobs and all! If you want to set it up on your own, you'll need to make sure that `rake app:update_milestones` gets run once a day (preferably as late as possible in the day). Running it multiple times a day has no negative impact.

## Getting started

Once you deploy the app, follow the instructions to set up some burndown charts. Then... wait! Burndown works by tracking progress every day. Which means you may have to wait a few days for your data to be interesting.

0 comments on commit 6747f02

Please sign in to comment.