commit 60e07ddfcee827034808ac0b08f4340edd8f740f
parent d3169deb1734db67152e47b5139c6a7b8c9abbfa
Author: Carlosokumu <carlosokumu254@gmail.com>
Date: Fri, 15 Aug 2025 22:07:01 +0300
update README.md
Diffstat:
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ python3 -m calendarapp.runnable.calendar_cli
## Commands
#### 1.Create
-To create an event entry:
+To create an event entry, the `create` command can be used as:
`create -s SUMMARY [--sf SUMMARY_FILE] -d DESCRIPTION [--df DESCRIPTION_FILE] --start START -l LOCATION -o ORGANIZER --tzid
TZID [--end END] [--duration DURATION] `
@@ -60,3 +60,11 @@ Note: On runing the create command, an `event.ics` file should be created in you
Using the `edit` command, you can modify an existing ical file's fields.
`edit -i ICAL_FILE_Path -s [SUMMARY] -d [DESCRIPTION] --start [START] -l [LOCATION] -o [ORGANIZER] ...`
+
+### Required fields
+
+| Option | Description | Format Example |
+|----------------------|----------------------|-----------------------------------------|
+| `-i`, `--ical` | Path to ical file | `"/events/ical.ics"` |
+
+Note: When an iCalendar file contains multiple events, include the `-a` or `--all` flag to be prompted to select the specific event you want to edit.
+\ No newline at end of file