Example

git-things-done · Dec 13, 2021 · 5612534 · 5612534
1 parent de646bf
commit 5612534
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -57,4 +57,18 @@ The ferret will search do a reverse chronological search for a comment with a
 markdown title matching `topic`, if it finds it it will replace the comment
 text with what it found.
 
+## For Example
+
+If you create a new comment with the text: `/ferret topic`, the ferret would
+look backwards through all your issues until it found a comment with this
+content:
+
+```markdown
+# topic
+
+foo bar baz.
+```
+
+The ferret would then replace the text `/ferret topic` with the above markdown.
+
 [GitTD]: https://github.com/git-things-done