diff --git a/bom/README.md b/bom/README.md new file mode 100644 index 000000000..90c52b4b4 --- /dev/null +++ b/bom/README.md @@ -0,0 +1,66 @@ +## `kotlin-faker-bom` + +[![Maven Central](https://img.shields.io/maven-central/v/io.github.serpro69/kotlin-faker-bom?style=for-the-badge)](https://search.maven.org/artifact/io.github.serpro69/kotlin-faker-bom) +[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.serpro69/kotlin-faker-bom?label=snapshot-version&server=https%3A%2F%2Foss.sonatype.org&style=for-the-badge&color=yellow)](#downloading) + +Kotlin-faker provides a [Bill-of-Materials](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms) that simplifies dependency management. + +## Usage + +Documentation for kotlin-faker is available at [serpro69.github.io/kotlin-faker/](https://serpro69.github.io/kotlin-faker/). + +### Downloading + +Latest releases are always available on maven central. + +**With gradle** + +To [import Maven BOM with Gradle](https://docs.gradle.org/current/userguide/platforms.html#sub:bom_import), a platform dependency needs to be declared on the `kotlin-faker-bom`. The rest of `kotlin-faker` dependencies do not need to specify the versions explicitly as they will be pulled from the BOM + +```groovy +dependencies { + implementation platform('io.github.serpro69:kotlin-faker-bom:$version') + implementation 'io.github.serpro69:kotlin-faker' + implementation 'io.github.serpro69:kotlin-faker-books' + implementation 'io.github.serpro69:kotlin-faker-tech' + // rest of dependencies +} +``` + +**With maven** + +To use the BOM, a dependency on `kotlin-faker-bom` needs to be declared in the `` block of the `pom.xml`, file: + +```xml + + + + io.github.serpro69 + kotlin-faker-bom + ${kotlin-faker.version} + pom + import + + + +``` + +Then add the dependencies as usual but w/o specifying the versions, which will be pulled from the BOM: + +```xml + + + io.github.serpro69 + kotlin-faker + + + io.github.serpro69 + kotlin-faker-books + + + io.github.serpro69 + kotlin-faker-tech + + + +``` diff --git a/docs/src/orchid/resources/wiki/faker-bom.md b/docs/src/orchid/resources/wiki/faker-bom.md new file mode 100644 index 000000000..e8228adb6 --- /dev/null +++ b/docs/src/orchid/resources/wiki/faker-bom.md @@ -0,0 +1,67 @@ +--- +--- + +# Kotlin-faker BOM + +[![Maven Central](https://img.shields.io/maven-central/v/io.github.serpro69/kotlin-faker-bom?style=for-the-badge)](https://search.maven.org/artifact/io.github.serpro69/kotlin-faker-bom) +[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/io.github.serpro69/kotlin-faker-bom?label=snapshot-version&server=https%3A%2F%2Foss.sonatype.org&style=for-the-badge&color=yellow)](#downloading) + +Kotlin-faker provides a [Bill-of-Materials](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms) that simplifies dependency management. + +## Usage + +### Downloading + +Latest releases are always available on maven central. + +**With gradle** + +To [import Maven BOM with Gradle](https://docs.gradle.org/current/userguide/platforms.html#sub:bom_import), a platform dependency needs to be declared on the `kotlin-faker-bom`. The rest of `kotlin-faker` dependencies do not need to specify the versions explicitly as they will be pulled from the BOM + +```groovy +dependencies { + implementation platform('io.github.serpro69:kotlin-faker-bom:$version') + implementation 'io.github.serpro69:kotlin-faker' + implementation 'io.github.serpro69:kotlin-faker-books' + implementation 'io.github.serpro69:kotlin-faker-tech' + // rest of dependencies +} +``` + +**With maven** + +To use the BOM, a dependency on `kotlin-faker-bom` needs to be declared in the `` block of the `pom.xml`, file: + +```xml + + + + io.github.serpro69 + kotlin-faker-bom + ${kotlin-faker.version} + pom + import + + + +``` + +Then add the dependencies as usual but w/o specifying the versions, which will be pulled from the BOM: + +```xml + + + io.github.serpro69 + kotlin-faker + + + io.github.serpro69 + kotlin-faker-books + + + io.github.serpro69 + kotlin-faker-tech + + + +``` diff --git a/docs/src/orchid/resources/wiki/getting-started.md b/docs/src/orchid/resources/wiki/getting-started.md index 430b7cd90..27c291b2a 100644 --- a/docs/src/orchid/resources/wiki/getting-started.md +++ b/docs/src/orchid/resources/wiki/getting-started.md @@ -8,6 +8,7 @@ * [Installing](#installing) * [Releases](#releases) * [Snapshots](#snapshots) + * [Faker BOM](#faker-bom) * [Generating Data](#generating-data) ## Installing @@ -26,6 +27,10 @@ Snapshot are automatically published on each commit to master. If you want to tr {% include 'includes/wiki/repositoriesTabs.peb' %} +### Faker BOM + +See {{ anchor(title='Kotlin-faker BOM', collectionType='wiki', collectionId='', itemId='Kotlin-faker BOM') }} page for details on how to use a Bill-of-Materials to simplify dependency management. + {% btc %}{% endbtc %}
diff --git a/docs/src/orchid/resources/wiki/summary.md b/docs/src/orchid/resources/wiki/summary.md index d20834704..e677a78c8 100644 --- a/docs/src/orchid/resources/wiki/summary.md +++ b/docs/src/orchid/resources/wiki/summary.md @@ -1,5 +1,6 @@ * [Getting Started](getting-started.md) +* [Kotlin-faker BOM](faker-bom.md) * [Faker Configuration](faker-configuration.md) * [Generator of Unique Values](unique-generator.md) * [Extras](extras.md)