From 7e100be1c20ec26bfd0c281b75d70ddc49512c42 Mon Sep 17 00:00:00 2001 From: kjg Date: Tue, 17 Mar 2026 16:39:47 +0900 Subject: [PATCH] docs: move Installation after Quick Start MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Users see code first, then decide to install — not the other way around. Matches the pattern of OkHttp, Retrofit, Jackson, Moshi READMEs. --- README.md | 60 +++++++++++++++++++++++++++---------------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 391139d..df5ec79 100644 --- a/README.md +++ b/README.md @@ -35,36 +35,6 @@ public void createUser(NonBlankString name, PositiveInt age, NonEmptyList *"I can just implement this myself. Why add a dependency?"* -> -> Totally fair! Copy the source into your project — it's MIT licensed. -> But if it saved you some time... give me a ⭐ 🥺 - -Published to [Maven Central](https://central.sonatype.com/artifact/io.github.junggikim/java-refined). Kotlin/JVM users can optionally add `java-refined-kotlin` for extension functions (adds `kotlin-stdlib` dependency). - -### Gradle Kotlin DSL - -```kotlin -dependencies { - implementation("io.github.junggikim:java-refined:1.1.0") - - // optional: Kotlin extensions - // implementation("io.github.junggikim:java-refined-kotlin:1.1.0") -} -``` - -### Maven - -```xml - - io.github.junggikim - java-refined - 1.1.0 - -``` - ## Quick Start ```java @@ -120,6 +90,36 @@ All refined wrappers follow the same pattern: Collection refined types implement JDK interfaces directly — `NonEmptyList` is a `List`, `NonEmptyMap` is a `Map`. No unwrapping needed. +## Installation + +> *"I can just implement this myself. Why add a dependency?"* +> +> Totally fair! Copy the source into your project — it's MIT licensed. +> But if it saved you some time... give me a ⭐ 🥺 + +Published to [Maven Central](https://central.sonatype.com/artifact/io.github.junggikim/java-refined). Kotlin/JVM users can optionally add `java-refined-kotlin` for extension functions (adds `kotlin-stdlib` dependency). + +### Gradle Kotlin DSL + +```kotlin +dependencies { + implementation("io.github.junggikim:java-refined:1.1.0") + + // optional: Kotlin extensions + // implementation("io.github.junggikim:java-refined-kotlin:1.1.0") +} +``` + +### Maven + +```xml + + io.github.junggikim + java-refined + 1.1.0 + +``` + ## Supported Types | Category | Examples | Count |