updating Readme

Author: mtiessler

README.md

@@ -5,27 +5,41 @@ Documentation writing in progress...
 
 ---
 
-### Demo & Screenshots
+## Demo & Screenshots
+
+---
+## Installation
+
 
-### Installation
 
-#### Local
+### Hugging Face Token Authentication & LLaMA Access
 
-#### Docker
+This project uses **Meta's LLaMA model**, which is **gated** and requires **manual approval** from Hugging Face.
 
-before using install spacy en_core_web_sm
+#### **How to Get Access to LLaMA**
+1. Visit the [LLaMA Model 3.2-3B Page](https://huggingface.co/meta-llama/Llama-3.2-3B).
+2. Click **Request Access** and follow the instructions.
+3. Wait for Hugging Face to approve your request.
 
-```python -m spacy download en_core_web_sm```
+#### **Using Your Hugging Face Token**
+To authenticate, you **must set your Hugging Face token** before running the project.
 
+In the `.env` file in the project root add:
 
-Example for calling csv_to_json.py
+```
+HUGGING_FACE_HUB_TOKEN=your_huggingface_token
+```
+---
+
+### Local Installation
 
-```python backend/data-preprocessing/csv_to_json.py -i data/COMMUNICATION/reviews_with_features.csv -o data/COMMUNICATION/features --from 2023-01-01 --to 2023-12-31```
+Before using, install the required spaCy model:
+```sh
+python -m spacy download en_core_web_sm
+```
+### Docker Installation
 
-Example for calling dendogram_generation.py client
+---
 
-```python client/dendogram_generation.py data/COMMUNICATION/all/features_org.telegram.messenger.json```
 
-Example for calling visualizator.py client
 
-```python client/dendogram_generation.py ./data/COMMUNICATION/all/features_com.discord.json bert-embedding-cosine average 0.2```