From 2f061f7d4cbf24a47a11b9c16393e925bd4a49b1 Mon Sep 17 00:00:00 2001 From: OmarAlJarrah Date: Sun, 19 Jul 2026 14:12:55 +0300 Subject: [PATCH] docs: bump README install snippets to the current release version The README's Maven Central coordinate table, Gradle and Maven install snippets, the Kuri.VERSION example, and the versioning-and-stability blurb all still pinned 0.1.0-alpha.1, three prereleases behind the actual current 0.1.0-alpha.4 in gradle.properties. Anyone who copy-pasted the install snippet as-is would pin a stale alpha and miss every fix since. These are hand-maintained literals rather than generated from the KURI_VERSION constant in kuri/build.gradle.kts: the Gradle/Maven snippets live inside fenced code blocks meant to be copied verbatim, so wiring them through a release-please extra-files marker would leave the marker comments visible in the copied snippet. Hand-fixing on each release, as this commit does, stays the simplest correct option for README.md specifically. Part of #99 --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5187471..97ce06c 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ module metadata selects the right per-platform variant automatically. |------------|-----------------| | Group | `org.dexpace` | | Artifact | `kuri` | -| Version | `0.1.0-alpha.1` | +| Version | `0.1.0-alpha.4` | > [!NOTE] > kuri is in an early **alpha** series: the public API is not yet frozen and may change between releases, so pin to an @@ -58,7 +58,7 @@ repositories { } dependencies { - implementation("org.dexpace:kuri:0.1.0-alpha.1") + implementation("org.dexpace:kuri:0.1.0-alpha.4") } ``` @@ -70,7 +70,7 @@ Gradle module metadata resolves the correct per-platform variant automatically. org.dexpace kuri-jvm - 0.1.0-alpha.1 + 0.1.0-alpha.4 ``` @@ -315,7 +315,7 @@ has no facade type — start from `Url` or `Uri`): Percent.encode("a b/c", Percent.Component.COMPONENT); // "a%20b%2Fc" Idn.toAscii("bücher.example").getOrNull(); // "xn--bcher-kva.example" Schemes.defaultPort("https"); // 443 (Integer) -String version = Kuri.VERSION; // e.g. "0.1.0-alpha.1" +String version = Kuri.VERSION; // e.g. "0.1.0-alpha.4" ``` ## Recipes @@ -573,7 +573,7 @@ the native test suites requires a matching operating system or simulator. ## Versioning and stability -kuri follows [Semantic Versioning 2.0.0](https://semver.org/). At `0.1.0-alpha.1` the public API is not yet frozen and +kuri follows [Semantic Versioning 2.0.0](https://semver.org/). At `0.1.0-alpha.4` the public API is not yet frozen and may change before `1.0.0`, and minor releases in the `0.x` series may carry breaking changes, so pin to an exact version. Every public signature is tracked in a checked-in binary-compatibility snapshot under `api/`, so an unintended API change fails the build (see [Building from source](#building-from-source)).