From 41adb67d96ae6c0944a1406da1c39816efd84afa Mon Sep 17 00:00:00 2001
From: Elena Yan <78790594+yan-elena@users.noreply.github.com>
Date: Sun, 5 May 2024 13:00:39 +0200
Subject: [PATCH] Update README.md

---
 README.md | 24 +++++++++++++++++++-----
 1 file changed, 19 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 672ff43..7b575a7 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Narrative Generator Component
 
-This repository contains a prototype implementation of the **Narrative Generator** for our research project _A Multi-Level Explainability Framework for BDI Multi Agent Systems_. You can access directly the deployed web application **[here](https://yan-elena.github.io/agent-explanation/)** without installing anything.
+This repository contains a prototype implementation of the **Narrative Generator** for our research project _A Multi-Level Explainability Framework for BDI Multi Agent Systems_. You can access directly the deployed web application **[here](https://yan-elena.github.io/agent-explanation/)**.
 
 ## A Multi-Level Explainability Framework for Engineering and Understanding BDI Agent Systems
 
@@ -13,16 +13,30 @@ The primary levels of abstraction identified in this study are as follows:
 
 ## Usage
 
-Try it out at **[https://yan-elena.github.io/agent-explanation](https://yan-elena.github.io/agent-explanation/)**.
+1a. Try it out at **[https://yan-elena.github.io/agent-explanation](https://yan-elena.github.io/agent-explanation/)** without installing anything.
 
-Following the instructions presented in the **[Logger Component](https://github.com/yan-elena/agent-logging)** to generate the `log files` of your Jason or JaCaMo project.
+1b. Or to use it locally, you need [Node.js](https://nodejs.org/en) and follow the instructions below.
+Install all dependencies required with:
+
+```
+npm install
+```
+
+Start the React development server with:
+
+```
+npm start
+```
+Reach `http://localhost:3000/agent-explanation` from your browser to access the dashboard.
+
+2. Following the instructions presented in the **[Logger Component](https://github.com/yan-elena/agent-logging)** to generate the `log files` of your Jason or JaCaMo project.
 Once you have the log files, you can upload them to the Home Page.
 
 <img src="https://github.com/yan-elena/agent-explanation/assets/78790594/2f3ba3c4-bd31-41ea-bd5f-ff588ee9824f" width=50%>
 
-At this point, you can navigate through the generated narratives at multiple levels for each agent in the system.
+3. At this point, you can navigate through the generated narratives at multiple levels for each agent in the system.
 
 <img src="https://github.com/yan-elena/agent-explanation/assets/78790594/ddfd0ca2-1475-4119-8c1a-c7ce318e5ed4" width=50%>
 
 ## Examples
-You can also use the example log files in the `/examples` folder to visualize the result and try the multi-level explanation.
+You can also use the log files in the `/examples` folder generated for the `alice-bob` and `domestic-robot` examples to try our multi-level explainability framework.