Skip to content
Merged
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,32 @@

It leverages [KSP](https://kotlinlang.org/docs/ksp-overview.html) to generate **type-safe definitions** used to power **Yawn Queries**.

## Getting Started

1. Add the Gradle dependencies to your build

```kotlin
plugins {
id("com.faire.yawn")
}

dependencies {
implementation("com.faire.yawn:yawn-api")
}
```

1. Write a query!

```kotlin
val yawn = Yawn(queryFactory = YourQueryFactory(...))
val tolkienBooks = yawn.query(BookTable) { books ->
val authors = join(books.author)
addEq(authors.name, "J. R. R. Tolkien")
}.list()
```

For more advanced details, read through our [docs](/docs/README.md)!

## Why Yawn?

### Full type safety
Expand Down
Loading