From 1e5fd236f3dc9d79cd7b6af02f0bec0c580571a3 Mon Sep 17 00:00:00 2001
From: Xavi Aracil <xaracil@1edtech.org>
Date: Tue, 10 Oct 2023 11:36:24 +0200
Subject: [PATCH] Added installation and run documentation

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

diff --git a/README.md b/README.md
index ca71f57..5cebf18 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,18 @@ This is primarily a validator for Open Badges 3.0 and Comprehensive Learner Reco
 
 ## User Documentation
 
+### Requirements
+
+- Java installed (tested with Java 17)
+- Maven installed (tested with Maven 3.8.6)
+
+### Installation & Run
+
+Navigate to main folder and run `mvn clean verify`. There's no need to install the packages in your repository.
+
+Run the webapp by navigate to the `inspector-vc-web` folder and run `mvn spring-boot:run`
+
+### Usage
 Run the webapp in the module `inspector-vc-web` and open a browser into `http://localhost:8080`. Once in the main page, select which validator to run from the list and provide your artifact / uri to validate.
 
 If you want to use the validator via API, point the browser to `http://localhost:8080/swagger-ui.html` for more documentation about the API.