aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhistoria <gravel.justness270@slmail.me>2024-08-07 15:12:42 -0400
committerhistoria <gravel.justness270@slmail.me>2024-08-07 15:12:42 -0400
commitedd24af0a7b79f418356d6a0c45d2ee23e3325df (patch)
treea347c64bdd752a40a178e8c909a4f56c023c20d6 /README.md
parent817524127a7a9183fb3b726e02dd6f39764b980f (diff)
downloadsoon-edd24af0a7b79f418356d6a0c45d2ee23e3325df.tar.gz
README update
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index fc7e4ab..724462f 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,13 @@ In terms of features and complexity, Soon lies between [When](https://www.lighta
2. Run `soon -e`. This will generate a config and calendar file under $XDG_CONFIG_HOME/soon and open the calendar file in your editor.
-3. Add some events and todos to your calendar file.
+3. Check the example calendar and add some events/todos. You can just add `J%2, Hello World` for an event that repeats every other day if you want to quickly see how it looks.
+
+4. Run `soon` to see your agenda. With no options it will show you the next 14 days of events as well as your todos and deadlines.
+
+5. Run `soon -i` to start interactive mode and archive events or todos. Select events/todos with HJKL and archive them with Space. Esc to exit.
+
+# Example Calendar
```
# Simple Dates
@@ -47,10 +53,6 @@ Fri 1W, First Friday of the month
+ Due: Aug 15 2025
```
-4. Run `soon` to see your agenda. With no options it will show you the next 14 days of events as well as your todos and deadlines.
-
-5. Run `soon -i` to start interactive mode and archive events or todos. Select events/todos with HJKL and archive them with Space. Esc to exit.
-
# .soon file syntax
Each event is a line with date conditions followed by `,` and a description.
@@ -212,7 +214,7 @@ Soon is a [When](https://www.lightandmatter.com/when/when.html) alternative with
2. Soon can archive the next instance of "Pay quarterly bill" after its paid early to hide it from your agenda without affecting later instances.
-3. Optionally keep all events on the agenda until manually archived. This mimics the behavior of keeping overdue calendar reminders in your email inbox.
+3. You can optionally keep events on the agenda until manually archived. This mimics the behavior of keeping overdue calendar reminders in your email inbox.
4. Zero nonsense todos with upcoming deadlines.