From cb1477a6a0c972e1caa0f044042b039dc964d0e3 Mon Sep 17 00:00:00 2001
From: Leah Neukirchen <leah@vuxu.org>
Date: Mon, 2 Oct 2017 15:40:35 +0200
Subject: README.md: add example

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/README.md b/README.md
index 33e980e..08697ee 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,53 @@ use `-f` to override) and *aggregate the tasks*:
 The result is printed as a tree, so you quickly see what you still
 need to do.
 
+## Example
+
+Consider this plan of a birthday party:
+
+```
+x buy a present
+- invite guests
+  x Estalla
+  - Zebby
+  - Orraleen
+  ? Xana
+- 2017-10-16 birthday cake
+  ? sprinkles
+  - flour
+  - sugar
+  x chocolate
+  x 1tsp salt
+  - eggs
+  X banana
+```
+
+We have three tasks, two of which have subtasks.  We bought a present
+already.  We need to invite two more guests, Zebby and Orraleen, and
+we don't know yet whether to invite Xana too.  The birthday cake needs
+to be done by October 16, 2017.  We need to buy flour, sugar, and
+eggs.  We already have chocolate and salt for it; and we certainly
+won't put bananas into it.  Perhaps, we'll put sprinkles on top, if we
+can find some.
+
+To get an overview of what remains to do, we run:
+
+```
+% notyet -f party.ny
+2017-10-16 {+14} [3/10]
+- 2017-10-16 {+14} birthday cake [2/6]
+  - eggs
+  - flour
+  - sugar
+  ? sprinkles
+- invite guests [1/3]
+  - Orraleen
+  - Zebby
+  ? Xana
+```
+
+The done tasks are hidden, and we know we have 14 days left to bake the cake.
+
 ## Special directives
 
 When a task description starts with a special directive, additional
-- 
cgit 1.4.1