commit ddff7ab0f560bdc395c56ad93973bd39f8f7b8a8
parent 67c14adc13729e2428c54fc950e6722631de65f0
Author: Carlosokumu <carlosokumu254@gmail.com>
Date: Wed, 20 Aug 2025 10:05:52 +0300
update README.md
Diffstat:
| M | README.md | | | 30 | +++++++++++++++++------------- |
1 file changed, 17 insertions(+), 13 deletions(-)
diff --git a/README.md b/README.md
@@ -42,19 +42,22 @@ 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] `
-### Required fields
-
-| Option | Description | Format Example |
-|----------------------|----------------------|-----------------------------------------|
-| `-s`, `--summary` | Event title | `"Team Meeting"` |
-| `-d`, `--description`| Event details | `"Quarterly review"` |
-| `--start` | Start time | `"10-09-2025 14:00"` (or ISO format) |
-| `--end ` | End time | `"10-09-2025 16:00"` |
-| `-l`, `--location` | Event venue | `"Conference Room A"` |
-| `-o`, `--organizer` | Contact email | `"events@company.com"` |
-| `--tzid` | Timezone | `"Africa/Nairobi"` |
+## Command Arguments
+
+| Option | Required | Input Type | Description | Format Example |
+|-----------------------------|----------|------------------|-----------------------------------------------------------------------------------------------------|--------------------------------------|
+| `-s`, `--summary` | Yes | Freeform text | Event title (short title shown in display). | `"Team Meeting"` |
+| `-sf`, `--summary-file` | No | File path string | File containing the event summary. | `summary.txt` |
+| `-d`, `--description` | Yes | Freeform text | Event details (brief, concise description). | `"Quarterly review"` |
+| `-df`, `--description-file` | No | File path string | File containing the event description. | `description.txt` |
+| `--start` | Yes | Datetime | Start time of the event. | `"10-09-2025 14:00"` (or ISO format) |
+| `--end` | No | Datetime | End time of the event. | `"10-09-2025 16:00"` |
+| `--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"` |
+| `-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"` |
-Note: On runing the create command, an `event.ics` file should be created in your current working directory.The generated `event.ics` file is currently a prototype and will change upon complete implementation of the command.
#### 2.Edit
Using the `edit` command, you can modify an existing ical file's fields.
@@ -68,4 +71,4 @@ Using the `edit` command, you can modify an existing ical file's fields.
| `-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.
+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
