From d2f3f67840e5249a9cd4137c1ba38d5095bec93e Mon Sep 17 00:00:00 2001
From: Jan Frenzel <jan.frenzel@tu-dresden.de>
Date: Wed, 21 Aug 2024 17:27:45 +0200
Subject: [PATCH] Improve description of base example

Co-authored-by: Andrei Politov <andrei.politov@tu-dresden.de>
---
 base/README.md | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/base/README.md b/base/README.md
index 15512e3..ab84aeb 100644
--- a/base/README.md
+++ b/base/README.md
@@ -1,6 +1,6 @@
 # Base functionality
 
-This example intends to show you how to:
+This is a basic example that intends to show you how to:
 
 - list models
 - select and use the first model with "llama" in its name to display a joke
@@ -17,7 +17,8 @@ pip install -r requirements.txt
 
 ## Usage
 
-1. Put your API key in the file `my_key`.
+1. Create a file `my_key` and put your API key in the file. 
+For security reasons API Key is necessary. You have to obtain the API Key from the llm.scads.ai team. You can find instructions [here](https://llm.scads.ai/)
 2. Then simply start the script `main.py` from your bash shell:
 
 ```bash
-- 
GitLab