From 7b55d2b37d63565ff32991c0205b6bfa99da0b20 Mon Sep 17 00:00:00 2001
From: Jean-Marie 'Histausse' Mineau <histausse@protonmail.com>
Date: Thu, 21 Mar 2024 17:20:04 +0100
Subject: [PATCH] document the 'todo' features

---
 README.md | 16 +++++++++++++++-
 lib.typ   |  2 +-
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c97af55..68886fa 100644
--- a/README.md
+++ b/README.md
@@ -57,11 +57,25 @@ c -- a;
 
 ### Todo
 
+Todos can be defined with the `todo` function. In addition to being highlighted, the unresolved totos are listed at the end of the generated document.
+
 ```
 Lorem ipsum dolore #todo[sit] amet
 ```
 
+To mark a todo as resolved without deleting it, you can mark it as such:
+
+```
+Lorem ipsum dolore #todo(done: true)[sit] amet
+```
+
+To hid todos, you can add this line at the top of the document:
+
+```
+#show-todos.update(_ => false)
+```
+
 ## TODO:
 
 - biblio
-- add a list of all todo at the end of the file
+- What to do with resolved toto?
diff --git a/lib.typ b/lib.typ
index 477aabe..2ef8d32 100644
--- a/lib.typ
+++ b/lib.typ
@@ -29,5 +29,5 @@
   #show raw.where(lang: "graphLR"): it => render-image("graph mygraph { rankdir=\"TB\";" + it.text + "}")
   #show raw.where(lang: "graphTB"): it => render-image("graph mygraph { rankdir=\"TB\";" + it.text + "}")
   #doc
-  #todos
+  #todos()
 ]