docs: add onixbyte-toolbox documentation

Add English and Chinese docs for the OnixByte Toolbox monorepo covering all six modules: common-toolbox, crypto-toolbox, math-toolbox, tuple, identity-generator, and version-catalogue.
2026-05-23 09:21:37 +08:00
parent 7f91c2bc23
commit 5b7c24fb0d
4 changed files with 526 additions and 0 deletions
@@ -0,0 +1,54 @@
+---
+title: OnixByte Toolbox
+---
+
+## 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:
+
+**Gradle (Kotlin DSL):**
+
+```kotlin
+implementation("com.onixbyte:common-toolbox:$version")
+implementation("com.onixbyte:crypto-toolbox:$version")
+implementation("com.onixbyte:math-toolbox:$version")
+implementation("com.onixbyte:tuple:$version")
+implementation("com.onixbyte:identity-generator:$version")
+```
+
+**Maven:**
+
+```xml
+<dependency>
+    <groupId>com.onixbyte</groupId>
+    <artifactId>common-toolbox</artifactId>
+    <version>${version}</version>
+</dependency>
+```
+
+Refer to the [changelog](https://codecrafters.org.cn/devkit/changelog) for available versions.
+
+## Requirements
+
+- Java 17 or later
+
+## License
+
+OnixByte Toolbox is open-source software released under the MIT License.