commit 6b9e482d038681b386d808da10e80189d9e21840 parent 59917ab92556a4f3a14ff19bc94f9dd8d58b60d4 Author: Carlosokumu <carlosokumu254@gmail.com> Date: Thu, 14 Aug 2025 00:54:11 +0300 update README.md Diffstat:
| M | README.md | | | 20 | ++++++++++++++++++++ |
1 file changed, 20 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -34,3 +34,23 @@ pip install -e . python3 -m calendarapp.runnable.calendar_cli ``` +## Basic Usage +To create a simple event entry: + +```bash +cal create [OPTIONS] +``` + + +### 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"` | +