From d8b032b67cfa123b98b86973301323b9071a6775 Mon Sep 17 00:00:00 2001 From: Glavo Date: Tue, 7 Jan 2025 22:50:27 +0800 Subject: [PATCH] Update README --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6409a0d0..810bd8c3 100644 --- a/README.md +++ b/README.md @@ -8,30 +8,32 @@ This is a powerful set of Java base libraries that provide a series of easy-to-use abstractions and collections. If you have used Scala, it should be easy for you to get started with this collection library. -It's not production ready and the API may change significantly in the future, -but we already use it in Aya language: -[aya-prover/aya-dev](https://github.com/aya-prover/aya-dev) +> [!NOTE] +> This library is not production ready. +> When [JEP 218 (Generics over Primitive Types)](https://openjdk.org/jeps/218) and [JEP 401 (Value Classes and Objects)](https://openjdk.org/jeps/401) were delivered, +> we needed to redesign many APIs. +> +> Until Kala Common is production-ready, we do not recommend that you use this library for production. Its documentation is not ready, please contact me if you have any questions. This project is hosted on GitHub: [Glavo/kala-common](https://github.com/Glavo/kala-common). -## Adding Kala to your build - -Please replace `$kala_version` with the current kala version. +## Add Kala Common to your project Maven: + ```xml org.glavo.kala kala-common - $kala_version + 0.79.0 ``` Gradle: ```kotlin -implementation("org.glavo.kala:kala-common:$kala_version") +implementation("org.glavo.kala:kala-common:0.79.0") ``` ## Note