diff --git a/README.md b/README.md index 01a66ee..4129b01 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,24 @@ -AppTemplate for Rally SDK +CapacityNotification for Rally SDK ========================= ## Overview -This Rakefile can be used to create a skeleton Rally app for use with Rally's App SDK. You must have Ruby 1.9 and the rake gem installed. - -The normal workflow for creating an App is to start by creating an App with the new task. - -Available tasks are: - - rake new[app_name,sdk_version,server] # Create an app with the provided name (and optional SDK version and rally server [default: https://rally1.rallydev.com]) - rake debug # Build a debug version of the app, useful for local development. - rake build # Build a deployable app which includes all JavaScript and CSS resources inline. Use after you app is working as you intend so that it can be copied into Rally. - rake clean # Clean all generated output - rake jslint # Run jslint on all JavaScript files used by this app - rake deploy # Deploy the app to a Rally server - rake deploy:debug # Deploy the debug app to a Rally server - rake deploy:info # Display deployment information +a. Why the App is useful + This app is useful to determine how your team is doing in their iterations. There are two implemented modules and more to come. + The first module shows up if your calculated load is over 100%. This generally means you are at high risk of not finishing up + your tasks for the iteration. The module shows a personal task burndown when you select on the tasks owned by you in the iteration. + You can see the ToDo values and whether or not they are staying in the same place or if you are on the right track. -You can find more information on installing Ruby and using rake tasks to simplify app development here: https://rally1.rallydev.com/apps/2.0p3/doc/#!/guide/appsdk_20_starter_kit - -## License - -AppTemplate is released under the MIT license. See the file [LICENSE](https://raw.github.com/RallyApps/AppTemplate/master/LICENSE) for the full text. + The second module is specifically for the project managers. It will let you know which users are at risk or above 100% calculated load, + or below 85%. If they are below 85, you can assign them more tasks using the grid that shows up on the screen, removing tasks from those + that have too much work and giving tasks to those that have too little work. + b. Any special configurations that the App needs to function + + Because real data was hard to come by we are using a fake data store for the first module. + + c. A screenshot of the App + https://docs.google.com/a/rallydev.com/document/d/1LhDF-4vllDCusvMSgddpjR0LprHCwrRxzirSVxK0fOc/edit + + d. A link to a your screencast demo + + https://docs.google.com/a/rallydev.com/open?id=0B32P36YwyqG8NkZKNTZzdjJFWU0