From adeb1b668a4d7051717e900dbb4cab58bd192ed0 Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Tue, 17 May 2022 23:39:55 +0200
Subject: README: Add a usage example

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 391e2e9..a728343 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,19 @@ user will be added as a watcher on all resulting issues.
 
 
 ## Usage
-TODO
+The following command adds ‘jira-user@example.com’ as a watcher on all Jira
+issues in the “FAKE” project that are not already watched by that user.
+Additionally, an email will be delivered to ‘jira-user@example.com’ using the
+`/usr/local/bin/maildrop` program for each of those issues, containing the issue
+summary, metadata, and description.
+
+	$ wajir \
+		--login 'jira-user@example.com' \
+		--token 'jp3cy1PFmDiCw73JJO6YL9Dj' \
+		--endpoint 'example.atlassian.net' \
+		--sendmail '/usr/local/bin/maildrop' \
+		--email-to 'jira-user@example.com' \
+		'project = "FAKE" AND watcher != currentUser() ORDER BY created ASC'
 
 
 ## Install
-- 
cgit v1.2.3