aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2022-05-17 23:39:55 +0200
committerTeddy Wing2022-05-17 23:39:55 +0200
commitadeb1b668a4d7051717e900dbb4cab58bd192ed0 (patch)
tree0c92c551ca32bdd74db2b3e43760d233e169eb3d
parentef161b247de914f4f57989ab0ff0b2b0f4a0feea (diff)
downloadwajir-adeb1b668a4d7051717e900dbb4cab58bd192ed0.tar.bz2
README: Add a usage example
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
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