From 6ae09a2069c690413bdeb8720876c63fae9a0256 Mon Sep 17 00:00:00 2001 From: Sargun Vohra Date: Sat, 7 Jun 2025 00:59:19 -0700 Subject: [PATCH] flesh out docs site --- README.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 4e576b7d..c00ffc9b 100644 --- a/README.md +++ b/README.md @@ -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/