From 2cb127a1b24bba0c12a5ac9ef5218b28ff3b80de Mon Sep 17 00:00:00 2001
From: Andrea Burattin <delas@users.noreply.github.com>
Date: Sat, 26 Mar 2022 23:16:21 +0100
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index 20caf7d..003e68f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,29 @@
 # Beamline framework [![](https://jitpack.io/v/beamline/framework.svg)](https://jitpack.io/#beamline/framework) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=beamline_framework&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=beamline_framework)
 
 Basic structure of the Beamline framework.
+
+For some general instructions on how to use the library see its website at https://beamline.cloud. For the JavaDoc documentation, visit https://beamline.github.io/framework/.
+
+This library is published as Maven project. To install it, it is necessary to include the proper repository with:
+```xml
+<repositories>
+    <repository>
+        <id>jitpack.io</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+```
+And then the actual dependency:
+```xml
+<dependency>
+    <groupId>com.github.beamline</groupId>
+    <artifactId>framework</artifactId>
+    <version>x.y.z</version>
+</dependency>
+```
+
+Some additional metrics from SonarCloud:
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=beamline_framework&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=beamline_framework)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=beamline_framework&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=beamline_framework)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=beamline_framework&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=beamline_framework)
+
-- 
GitLab