commit e1eb4dee7cb00942e6c3df490031447fa432ca62
parent ddff7ab0f560bdc395c56ad93973bd39f8f7b8a8
Author: Carlosokumu <carlosokumu254@gmail.com>
Date: Wed, 20 Aug 2025 14:09:19 +0300
update README.md
Diffstat:
1 file changed, 5 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -55,7 +55,7 @@ To create an event entry, the `create` command can be used as:
| `--duration` | No | Duration string | Duration of the event (alternative to `--end`). | `"PT2H"` (ISO 8601) |
| `-l`, `--location` | Yes | Freeform string | Event venue or location. | `"Conference Room A"` |
| `-o`, `--organizer` | Yes | Freeform string | Organizer’s contact (e.g., name or email). | `"events@company.com"` |
-| `--tzid` | Yes | Freeform string | Timezone identifier (e.g., Olson database name). | `"Africa/Nairobi"` |
+| `--tzid` | Yes | Freeform string | Timezone identifier | `"Africa/Nairobi"` |
| `-f`, `--file` | No | Freeform string | Output filename for the generated iCalendar file.<br>If not provided, a safe timestamped filename (e.g., `event_20250820_083410.ics`) will be used. | `"team_meeting.ics"` |
@@ -64,11 +64,7 @@ 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: If the iCalendar file contains multiple events, use the `-a` or `--all` flag to be prompted to choose which event to edit. Without this flag, only the first event in the file will be modified. Field updates can be provided directly as command arguments, or you can update them interactively when prompted.
-\ No newline at end of file
+| Option | Required | Description | Format Example |
+|--------------------|----------|-------------------|----------------------|
+| `-i`, `--ical` | Yes | Path to ical file | `"/events/ical.ics"` |
+| `-a`, `--all` | No | Apply to all events in the iCal file. If omitted, only the first event is modified. | - |
