Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add BOM to README.adoc #332

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Add BOM to README.adoc #332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,43 @@
:sonar: https://sonarcloud.io/dashboard?id=smallrye_smallrye-common

image:https://github.com/smallrye/smallrye-common/workflows/SmallRye%20Build/badge.svg?branch=main[link={ci}]
image:https://sonarcloud.io/api/project_badges/measure?project=smallrye_smallrye-common&metric=alert_status["Quality Gate Status", link={sonar}]
image:https://img.shields.io/github/license/smallrye/smallrye-common.svg["License", link="http://www.apache.org/licenses/LICENSE-2.0"]
image:https://sonarcloud.io/api/project_badges/measure?project=smallrye_smallrye-common&metric=alert_status["Quality Gate Status",link={sonar}]
image:https://img.shields.io/github/license/smallrye/smallrye-common.svg["License",link="http://www.apache.org/licenses/LICENSE-2.0"]
image:https://img.shields.io/maven-central/v/io.smallrye.common/smallrye-common-parent?color=green[["Central", link="https://search.maven.org/search?q=g:io.smallrye.common"]

= SmallRye Common
== SmallRye Common

Common utilities for SmallRye projects.

== Instructions
=== Usage

Add the `io.smallrye.common:smallrye-common-bom` to your `<dependencyManagement>`:

[source,xml]
----
<dependency>
<groupId>io.smallrye.common</groupId>
<artifactId>smallrye-common-bom</artifactId>
<version>LATEST</version>
<type>pom</type>
<scope>import</scope>
</dependency>
----

Now you can add the dependencies you need without worrying about the versions.

For example:

[source,xml]
----
<!-- Add a dependency to the SmallRye Common IO module -->
<dependency>
<groupId>io.smallrye.common</groupId>
<artifactId>smallrye-common-io</artifactId>
</dependency>
----

=== Development

Compile and test the project:

Expand Down