onixbyte/onixbyte-bom
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: split modules to separate repos

Browse Source
This commit is contained in:
Siu Jam Oh
2026-06-02 13:42:43 +08:00
parent 7e1b7cae85
commit 80bec17c7d
49 changed files with 132 additions and 5168 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+36 -33
View File
@@ -1,46 +1,49 @@
# OnixByte Toolbox
# Version Catalogue
![Static Badge](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fcom%2Fonixbyte%2Fversion-catalogue%2Fmaven-metadata.xml&query=%2F%2Fmetadata%2Fversioning%2Flatest&label=version)
![Static Badge](https://img.shields.io/badge/licence-MIT-green)
![Static Badge](https://img.shields.io/badge/java-%E2%89%A517-blue)
The **Version Catalogue** (Bill of Materials) is a Maven POM file provided by OnixByte to manage
dependency versions for the **OnixByte Toolbox**. By incorporating this BOM into your build
configuration, you can ensure consistent versioning across all included dependencies without
needing to specify versions explicitly in your project files. Published with Gradle metadata,
this BOM supports both Maven and Gradle projects, and this document outlines how to integrate
and use it effectively in both ecosystems.
## Using in Maven
OnixByte Toolbox is a Java Development Kit that offers a set of convenient tools for writing code efficiently.
Add the `version-catalogue` to your `pom.xml` under `<dependencyManagement>`:
## Installation and Usage
If you are using **Maven**, please paste the following codes to _pom.xml_ in your project.
```xml
<dependency>
<groupId>com.onixbyte</groupId>
<artifactId>${artifactId}</artifactId>
<version>${version}</version>
</dependency>
```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.onixbyte</groupId>
<artifactId>version-catalogue</artifactId>
<version>3.0.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
```
If you are using **Gradle**, please paste the following codes to _buile.gradle\[.kts\]_ in your project.
Then reference any dependency built by OnixByte without a version.
## Using in Gradle
In your `build.gradle[.kts]`, apply the BOM using the `platform` dependency:
```groovy
implementation 'com.onixbyte:$artifactId:$version'
dependencies {
implementation platform('com.onixbyte:version-catalogue:3.0.0')
implementation 'com.onixbyte:common-toolbox'
}
```
If you are using Kotlin DSL:
```kotlin
implementation("com.onixbyte:$artifactId:$version")
dependencies {
implementation(platform("com.onixbyte:version-catalogue:3.0.0"))
implementation("com.onixbyte:common-toolbox")
}
```
If you want to check the available versions, please check out at our [official site](https://codecrafters.org.cn/devkit/changelog).
## Contribution
Contributions are welcome! If you encounter any issues or want to contribute to the project, please feel free to **[raise an issue](https://github.com/CodeCraftersCN/jdevkit/issues/new)** or **[submit a pull request](https://github.com/CodeCraftersCN/jdevkit/compare)**.
## License
This project is licensed under the [MIT](/LICENSE).
## Contact
If you have any suggestions, ideas, don't hesitate contacting us via [GitHub Issues](https://github.com/CodeCraftersCN/jdevkit/issues/new) or [Discord Community](https://discord.gg/NQK9tjcBB8).
If you face any bugs while using our library and you are able to fix any bugs in our library, we would be happy to accept pull requests from you on [GitHub](https://github.com/CodeCraftersCN/jdevkit/compare).