From e82f7a5525c3fcd681fc6e155f63a2766dbd285d Mon Sep 17 00:00:00 2001
From: Pierre Auguste <pierre.auguste4@etu.univ-lorraine.fr>
Date: Fri, 18 Oct 2024 14:42:16 +0200
Subject: [PATCH] docs - fill the readme

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

diff --git a/README.md b/README.md
index 606f573..52ab525 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
 # CrashLab_02
 
+```sh
+# Install the package locally
+npm install curator-ai
+```
+
+Put the API key in a `.env` file:
+
+```txt
+OPENAI_API_KEY=XXX
+```
+
+Change the index.ts file, then :
+
+```sh
+tsc index.ts
+```
+
+And for the execution :
+```sh
+node index.js
+```
\ No newline at end of file
-- 
GitLab