diff --git a/README.md b/README.md index 20caf7d1c246df08ad213f9af4cebbcb5ba583ec..003e68f1d03d2b01581c506b8e7dafe513ac8724 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,29 @@ # Beamline framework [](https://jitpack.io/#beamline/framework) [](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: +[](https://sonarcloud.io/summary/new_code?id=beamline_framework) +[](https://sonarcloud.io/summary/new_code?id=beamline_framework) +[](https://sonarcloud.io/summary/new_code?id=beamline_framework) +