zihluwang
861852961f
These files were already out of step with the project's Prettier config before this branch of work; running `pnpm format` finally swept them up. No semantic changes. Kept separate from the functional commits so the reformatting does not bury them in diff noise.
55 lines
2.2 KiB
Plaintext
55 lines
2.2 KiB
Plaintext
---
|
|
title: OnixByte Toolbox
|
|
---
|
|
|
|
import { Tabs, Tab } from "@rspress/core/theme"
|
|
|
|
## Introduction
|
|
|
|
OnixByte Toolbox is a Development Kit for Java applications that provides a set of convenient, reusable tools for writing code efficiently. It is designed and maintained by OnixByte as a monorepo containing multiple purpose-built libraries, each addressing a specific development need — from common utilities and cryptography to mathematical computation and identity generation.
|
|
|
|
The toolkit is available on Maven Central under the `com.onixbyte` group ID. Each module is independently versioned and can be included in any Java 17+ project.
|
|
|
|
## Modules
|
|
|
|
| Module | Artifact ID | Description |
|
|
| ------------------ | -------------------- | ------------------------------------------------------------------------- |
|
|
| Common Toolbox | `common-toolbox` | Everyday utilities — AES, hashing, Base64, collections, branching, ranges |
|
|
| Crypto Toolbox | `crypto-toolbox` | Public/private key loading for RSA and ECDSA algorithms |
|
|
| Math Toolbox | `math-toolbox` | Statistical calculation, percentile analysis, quartile computation |
|
|
| Tuple | `tuple` | Generic 2-tuple and 3-tuple with immutable variants |
|
|
| Identity Generator | `identity-generator` | Snowflake-style and sequential UUID identity generation |
|
|
| Version Catalogue | `version-catalogue` | Centralised Gradle version catalogue for OnixByte projects |
|
|
|
|
## Installation
|
|
|
|
Add the desired module as a dependency in your build config:
|
|
|
|
<Tabs>
|
|
<Tab label="Gradle with Kotlin DSL">
|
|
```kotlin title="build.gradle.kts"
|
|
dependencies {
|
|
implementation("com.onixbyte:$artefactId:$version")
|
|
}
|
|
```
|
|
</Tab>
|
|
|
|
<Tab label="Maven">
|
|
```xml title="pom.xml"
|
|
<dependency>
|
|
<groupId>com.onixbyte</groupId>
|
|
<artifactId>${artefactId}</artifactId>
|
|
<version>${version}</version>
|
|
</dependency>
|
|
```
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
## Requirements
|
|
|
|
- Java 17 or later
|
|
|
|
## License
|
|
|
|
OnixByte Toolbox is open-source software released under the MIT Licence.
|