Skip to content

Commit

Permalink
Mention Maven Central and Maven config in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tsjensen committed Mar 10, 2025
1 parent e78b745 commit e095c6b
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,37 @@
[![build](https://github.com/siemens/standard-bom-java/actions/workflows/build.yml/badge.svg)](https://github.com/siemens/standard-bom-java/actions/workflows/build.yml)
[![codecov](https://codecov.io/gh/siemens/standard-bom-java/graph/badge.svg?token=03UC0U5M10)](https://codecov.io/gh/siemens/standard-bom-java)
[![Maven Central](https://img.shields.io/maven-central/v/com.siemens.sbom.standardbom/standard-bom)](https://central.sonatype.com/artifact/com.siemens.sbom.standardbom/standard-bom)


# Standard BOM for Java

A Java library for creating and consuming documents in
[standard-bom format](https://sbom.siemens.io/latest/format.html).
[standard-bom format](https://sbom.siemens.io/latest/format.html). "Standard BOM" is our Siemens-internal SBOM
format. Every Standard BOM document is a 100% [CycloneDX](https://cyclonedx.org/) document, so consumers who do not
know about Stanard BOM can just treat it as CycloneDX and be happy.


## Build script config

In order to use the Java library in your project, add it to your Gradle or Maven build.

TODO mention MavenCentral when publishing there is set up
In order to use the Java library in your project, add it to your Gradle or Maven build. We publish on Maven Central,
so no special configuration is needed.

**build.gradle**
**Gradle**
```groovy
dependencies {
implementation 'com.siemens.sbom.standardbom:standard-bom:4.1.2'
}
```

**Maven**
```xml
<dependency>
<groupId>com.siemens.sbom.standardbom</groupId>
<artifactId>standard-bom</artifactId>
<version>4.1.2</version>
</dependency>
```


## Usage

Expand Down Expand Up @@ -79,9 +91,6 @@ Run the build by executing
./gradlew clean build
```

Publish a new version of this library by pushing a protected version tag in the format `vX.Y.Z`. The CI jobs will do
the rest.


## License

Expand Down

0 comments on commit e095c6b

Please sign in to comment.