README.md in trollolo-0.2.0 vs README.md in trollolo-0.3.0
- old
+ new
@@ -19,11 +19,11 @@
[example Trello board](https://trello.com/b/CRdddpdy/trollolo-testing-board)
which demonstrates the expected structure.
## Installation
-You need to have Ruby install. Trollolo works with Ruby 2.2-2.4.1, but currently it doesn't work with 2.4.2. See [#139](https://github.com/openSUSE/trollolo/issues/139) for more information.
+You need to have Ruby install. Trollolo works with Ruby >= 2.2.
You can install Trollolo as gem with `gem install trollolo`.
For the chart generation you will need a working matplotlib installation and
the python module to read YAML. On openSUSE you can get that with
@@ -137,11 +137,10 @@
:sprint => Current running sprint
:board => Board ID
-
To generate the actual burndown chart, go to the working directory and call:
trollolo plot SPRINT_NUMBER
or fetch and plot data in one step with:
@@ -153,9 +152,48 @@
`burndown-SPRINT_NUMBER.png` you can upload as cover graphics to a card on your
Trello board.
Some more info can be found in the command line help with `trollolo help` and
`trollolo help burndown`.
+
+### Swimlanes
+
+You can define swimlanes to exclude certain cards from the normal burndown
+data. This can be useful when you track work of multiple projects on the same
+board and you don't want to apply the full Scrum framework to all of them. An
+example would be a side project which you limit to one card in process.
+
+Swimlanes are defined by putting a label with the name of the swimlane on all
+cards which belong to this swimlane. It does not matter in which column they
+are. To make Trollolo aware of the swimlane, you need to add an entry in the
+meta section of the burndown YAML such as:
+
+ meta:
+ swimlanes:
+ - My Side Project
+
+This lets Trollolo exclude all cards which have the label with the name
+`My Side Project` from the burndown chart.
+
+The data for swimlane cards is collected separately in the burndown YAML
+separated in `todo`, `doing`, and `done` values. This can be used to generate
+statistics for the swimlanes. Trollolo currently only writes the raw data
+but doesn't support any statistics such as generating graphs.
+
+### Column names
+
+Trollolo by default looks for columns named such as `Sprint Backlog`, `Doing`,
+or `Done`. If you need more or other names you can configure that in the burndown
+YAML. Here is an example:
+
+ meta:
+ todo_columns:
+ - Main Backlog
+ - Swimlane Backlog
+ doing_columns:
+ - Doing
+ - Review
+ - QA
### Example
