Skip to content

docs: reorder Quick Start before Installation, add friendly tone #26

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 16, 2026
Merged

docs: reorder Quick Start before Installation, add friendly tone #26

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
53 changes: 29 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,37 @@ public void createUser(NonBlankString name, PositiveInt age, NonEmptyList<String

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

## Quick Start

```java
import io.github.junggikim.refined.refined.numeric.PositiveInt;
import io.github.junggikim.refined.refined.string.NonBlankString;
import io.github.junggikim.refined.refined.collection.NonEmptyList;
import io.github.junggikim.refined.validation.Validation;
import io.github.junggikim.refined.violation.Violation;
import java.util.Arrays;

// of() returns Validation — never throws
Validation<Violation, PositiveInt> age = PositiveInt.of(18);
Validation<Violation, NonBlankString> name = NonBlankString.of("Ada");
Validation<Violation, NonEmptyList<String>> tags =
NonEmptyList.of(Arrays.asList("java", "fp")); // or List.of() on Java 9+

// combine results
Validation<Violation, String> summary =
name.zip(age, (n, a) -> n.value() + " (" + a.value() + ")");

// unsafeOf() throws on invalid input — use at trusted boundaries
PositiveInt confirmedAge = PositiveInt.unsafeOf(18);
```

## 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
Expand All @@ -60,30 +89,6 @@ dependencies {
</dependency>
```

## Quick Start

```java
import io.github.junggikim.refined.refined.numeric.PositiveInt;
import io.github.junggikim.refined.refined.string.NonBlankString;
import io.github.junggikim.refined.refined.collection.NonEmptyList;
import io.github.junggikim.refined.validation.Validation;
import io.github.junggikim.refined.violation.Violation;
import java.util.Arrays;

// of() returns Validation — never throws
Validation<Violation, PositiveInt> age = PositiveInt.of(18);
Validation<Violation, NonBlankString> name = NonBlankString.of("Ada");
Validation<Violation, NonEmptyList<String>> tags =
NonEmptyList.of(Arrays.asList("java", "fp")); // or List.of() on Java 9+

// combine results
Validation<Violation, String> summary =
name.zip(age, (n, a) -> n.value() + " (" + a.value() + ")");

// unsafeOf() throws on invalid input — use at trusted boundaries
PositiveInt confirmedAge = PositiveInt.unsafeOf(18);
```

## Kotlin Support

Optional module with Kotlin-idiomatic extensions:
Expand Down