From a2d82730113eb790d1e7a60090c9161b28a3e5d3 Mon Sep 17 00:00:00 2001
From: haoyuren <13851610112@163.com>
Date: Fri, 6 Dec 2024 23:07:56 -0600
Subject: readme update

---
 README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)

diff --git a/README.md b/README.md
index e69de29..411b5df 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,49 @@
+# Meeting Extractor
+
+This is a simple script that extracts meeting details from an email. It uses the OpenAI API to extract the meeting details from the email content.
+
+## Installation
+
+1. Clone the repository
+2. Install the dependencies
+```
+pip install openai
+pip install pyyaml
+```
+3. Set the OpenAI API key in the `api-key.yaml` file
+4. Run the script
+
+## Open-ai API Key
+
+You can get the OpenAI API key from [here](https://platform.openai.com/api-keys).
+A valid API key starts with `sk-proj-`.
+
+## Usage
+
+1. Run the script
+2. Enter the email content when prompted
+3. The script will output the extracted meeting details with a format of YAML.
+```
+{
+    "meetings": [
+        {
+            "time": "2024-03-20 14:00 - 15:00",
+            "location": "Conference Room A",
+            "description": "Project progress discussion",
+            "title": "Project Update"
+        },
+        {
+            "time": "2024-03-22 10:30 - 11:30",
+            "location": "Virtual Meeting",
+            "description": "Sprint review meeting",
+            "title": "Sprint Review"
+        }
+    ]
+}
+```
+If no meetings are found, the script will output:
+```
+{
+    "meetings": null
+}
+```
\ No newline at end of file
-- 
cgit v1.2.3