Skip to content

Commit 2ce930b

Browse files
master: update documentation
1 parent 12256c0 commit 2ce930b

File tree

1 file changed

+38
-9
lines changed

1 file changed

+38
-9
lines changed

README.md

+38-9
Original file line numberDiff line numberDiff line change
@@ -176,28 +176,57 @@ SMALLSCREEN=('DOING' 'TODO' 'HOLD') # define simplified kanban board statuses
176176

177177
## Nested kanbans
178178

179+
Besides regular tickets, infinite nested kanbans are supported too, as well as adding a kanban as a ticket.
180+
179181
```bash
180182
$ kanban init
181-
$ mkdir featureX
182-
$ kanban add TODO featureX
183-
$ cd featureX
184-
$ kanban init
185-
$ kanban add TODO foobar
183+
$ mkdir v3
184+
$ mkdir v3/v4
185+
$ cd v3 && kanban init && kanban add a foo && cd -
186+
$ cd v3/v4 && kanban init && kanban add b bar && cd -
187+
$ kanban add TODO dev foobar
186188
$ cd ..
187189
$ kanban show
188190
.____.
189191
| TODO |_____
190192
|
191-
| 12 featureX
193+
| 1 #dev foobar
194+
195+
kanbans:
196+
├─ v3
197+
├─ v3/v4
198+
199+
200+
$ kanban v3 # shows v3 kanban
201+
.____.
202+
| TODO |_____
203+
|
204+
| 1 #a foo
205+
```
206+
207+
Now lets add the `v3/v4` kanban as a ticket:
208+
209+
```bash
210+
$ kanban add TODO foo v3/v4
211+
$ kanban show
212+
.____.
213+
| TODO |_____
214+
|
215+
| 1 #dev foobar
216+
| 2 #foo v3/v4
217+
218+
kanbans:
219+
├─ v3
220+
├─ v3/v4
192221

193-
$ kanban 12 # shows kanban inside featureX
222+
$ kanban 2 # shows v3/v4 kanban
194223
.____.
195224
| TODO |_____
196225
|
197-
| 1 foobar
226+
| 1 #b bar
198227
```
199228

200-
> Or, how about centralized kanbans in your dotfiles repo + 1 in a projectrepo
229+
# kanbans in your [dotfiles] GIT-repo + 1 in a projectrepo
201230

202231
```
203232
$ cd ~ # go to homedir (where your dotfiles live)

0 commit comments

Comments
 (0)