refactor: change to MIT license and reformat codes
This commit is contained in:
+14
-11
@@ -1,17 +1,22 @@
|
||||
# DevKit BOM
|
||||
# Version Catalogue
|
||||
|
||||
The devkit-bom (Bill of Materials) is a Maven POM file provided by OnixByte to manage dependency versions for the DevKit suite of libraries. 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.
|
||||
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
|
||||
|
||||
Add the `devkit-bom` to your `pom.xml` under `<dependencyManagement>`:
|
||||
Add the `version-catalogue` to your `pom.xml` under `<dependencyManagement>`:
|
||||
|
||||
```xml
|
||||
<dependencyManagement>
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.onixbyte</groupId>
|
||||
<artifactId>devkit-bom</artifactId>
|
||||
<artifactId>version-catalogue</artifactId>
|
||||
<version>${devkit-version}</version>
|
||||
<type>pom</type>
|
||||
<scope>import</scope>
|
||||
@@ -20,7 +25,7 @@ Add the `devkit-bom` to your `pom.xml` under `<dependencyManagement>`:
|
||||
</dependencyManagement>
|
||||
```
|
||||
|
||||
Then reference dependencies like `devkit-core` without a version.
|
||||
Then reference any dependency built by OnixByte without a version.
|
||||
|
||||
## Using in Gradle
|
||||
|
||||
@@ -28,9 +33,8 @@ In your `build.gradle[.kts]`, apply the BOM using the `platform` dependency:
|
||||
|
||||
```groovy
|
||||
dependencies {
|
||||
implementation platform('com.onixbyte:devkit-bom:2.0.0')
|
||||
implementation 'com.onixbyte:devkit-core'
|
||||
implementation 'com.onixbyte:devkit-utils'
|
||||
implementation platform('com.onixbyte:version-catalogue:2.0.0')
|
||||
implementation 'com.onixbyte:common-toolbox'
|
||||
}
|
||||
```
|
||||
|
||||
@@ -38,9 +42,8 @@ If you are using Kotlin DSL:
|
||||
|
||||
```kotlin
|
||||
dependencies {
|
||||
implementation(platform("com.onixbyte:devkit-bom:2.0.0"))
|
||||
implementation("com.onixbyte:devkit-core")
|
||||
implementation("com.onixbyte:devkit-utils")
|
||||
implementation(platform("com.onixbyte:version-catalogue:2.0.0"))
|
||||
implementation("com.onixbyte:common-toolbox")
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
@@ -1,19 +1,25 @@
|
||||
/*
|
||||
* Copyright (C) 2024-2025 OnixByte.
|
||||
* Copyright (c) 2024-2025 OnixByte
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
*
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
*/
|
||||
|
||||
import java.net.URI
|
||||
|
||||
plugins {
|
||||
|
||||
Reference in New Issue
Block a user