Skip to content

docs: move Installation after Quick Start #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JunggiKim merged 1 commit into from
Mar 17, 2026
Merged

docs: move Installation after Quick Start #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,36 +35,6 @@ public void createUser(NonBlankString name, PositiveInt age, NonEmptyList<String

Types replace scattered `if`-checks. Invalid data cannot even reach your method.

## 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
<dependency>
<groupId>io.github.junggikim</groupId>
<artifactId>java-refined</artifactId>
<version>1.1.0</version>
</dependency>
```

## Quick Start

```java
Expand Down Expand Up @@ -120,6 +90,36 @@ All refined wrappers follow the same pattern:

Collection refined types implement JDK interfaces directly — `NonEmptyList<T>` is a `List<T>`, `NonEmptyMap<K,V>` is a `Map<K,V>`. 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
<dependency>
<groupId>io.github.junggikim</groupId>
<artifactId>java-refined</artifactId>
<version>1.1.0</version>
</dependency>
```

## Supported Types

| Category | Examples | Count |
Expand Down