aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhistoria <gravel.justness270@slmail.me>2024-08-07 04:10:34 -0400
committerhistoria <gravel.justness270@slmail.me>2024-08-07 04:10:34 -0400
commit6d3740e68631530dd612d5dc56cc83b990003e25 (patch)
tree9dd0070a8c28a3e572ae17a92c453e0beb25326e /README.md
parent1320375ebc0e87956807c0c543abe9f9a9f1dd6e (diff)
downloadsoon-6d3740e68631530dd612d5dc56cc83b990003e25.tar.gz
CLI option parsing and recursively search calendar path
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 13 insertions, 15 deletions
diff --git a/README.md b/README.md
index 7f77316..83898b6 100644
--- a/README.md
+++ b/README.md
@@ -16,27 +16,25 @@ In terms of features and complexity, Soon lies between [When](https://www.lighta
# Arguments
```
-Usage: soon [options] [commands] [file]
+Usage: soon [options]
Options:
--p, --past DAYS days in past to print agenda (default: 1)
--f, --future DAYS days in future to print agenda (default: 14)
+-a print agenda (default behavior if no options)
+-c print reference calendar
+-t print todos
+-e open default calendar file in $EDITOR
+-i open TUI in interactive mode to schedule/archive events
+-w, -m, -y print agenda for upcoming week, month, or year
+-j print the modified julian day
+-d print today's date
+-p, --past=DAYS days in past to print agenda (default: 1)
+-f, --future=DAYS days in future to print agenda (default: 14)
-h, --help show this help
-v, --version print version
-Commands:
-a print agenda
-c print calendar
-t print todos
-e open default calendar file in $EDITOR
-i open TUI in interactive mode to schedule/archive events
-w, m, y print agenda for upcoming week, month, or year
-j print the modified julian day
-d print today's date
-
Combine commands to get output in a certain order.
-`soon ca` prints a calendar followed by an agenda.
-`soon at` prints an agenda followed by todos.
+`soon -ca` prints a calendar followed by an agenda.
+`soon -at` prints an agenda followed by todos.
Check the docs at https://codeberg.org/historia/soon
```