Skip to content

update readme #109

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
merged 1 commit into from
Jun 7, 2025
Merged

update readme #109

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
24 changes: 8 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,16 @@

Maintainer: [@sargunv](https://github.com/sargunv)

This is a [Kotlin](https://kotlinlang.org/) client for
[PokeApi](https://github.com/PokeAPI/pokeapi).
PokeKotlin is a modern [Kotlin Multiplatform] client for [PokéAPI]. It supports
Kotlin JVM, JS, WASM, and Native. Under the hood, it's built on [Ktor], [Kotlin
Serialization], and coroutines.

## Installation

Since v2.5.0, the library is published to Maven Central.

Current version:
![Maven Central Version](https://img.shields.io/maven-central/v/dev.sargunv.pokekotlin/pokekotlin)

### Gradle
## Usage

```kts
dependencies {
implementation("dev.sargunv.pokekotlin:pokekotlin:VERSION")
}
```
- [Documentation]
- [API Reference]

## Usage

See the [API Reference](https://pokeapi.github.io/pokekotlin/api/).
[Documentation]: https://pokeapi.github.io/pokekotlin/
[API Reference]: https://pokeapi.github.io/pokekotlin/api/