ungana

commit 71c1a64e713264e78f6e46d2eeb2e39388879bc2
parent 6b9e482d038681b386d808da10e80189d9e21840
Author: Carlosokumu <carlosokumu254@gmail.com>
Date:   Thu, 14 Aug 2025 11:27:12 +0300

update README.md

Diffstat:
M
README.md
 | 
13
+++++++------

1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 
 ## Setup (Recommended)
 
-### 1. Create a Virtual Environment
+### Create a Virtual Environment
 First, create and activate a virtual environment to isolate the project dependencies:
 
 ```bash
@@ -34,13 +34,13 @@ pip install -e .
 python3 -m calendarapp.runnable.calendar_cli
 ```
 
-## Basic Usage
-To create a simple event entry: 
+## Commands
 
-```bash
-cal create [OPTIONS]
-```
+#### 1.Create 
+To create an event entry:
 
+ `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
 
@@ -54,3 +54,4 @@ cal create [OPTIONS]
 | `-o`, `--organizer`  | Contact email        | `"events@company.com"`                  |
 | `--tzid`             | Timezone             | `"Africa/Nairobi"`                      |
 
+Note: On runing the create command, an `event.ics` file should be created.