pokekotlin icon indicating copy to clipboard operation
pokekotlin copied to clipboard

Documentation

Open sargunv opened this issue 9 years ago • 5 comments

This library should have a more detailed documentation and some examples.

EDIT: Should do this after 2.0.0

sargunv avatar Jun 09 '16 18:06 sargunv

hey there, is anyone working on this still?

Mathreyu avatar Nov 15 '17 17:11 Mathreyu

Sorry, I’ve been busy lately. Is there something specific you need? I can probably take a look this weekend.

sargunv avatar Nov 15 '17 18:11 sargunv

hey, dont sweat it :) I was just trying to make an app on kotlin using this library, but the lack of documentation is making it hard to use. When I'm done with it I might upload it as an example of usage.

Mathreyu avatar Nov 15 '17 18:11 Mathreyu

The functions should correspond 1:1 with the PokeApi documentation.

You may find these helpful:

  • API interface: https://github.com/PokeAPI/pokekotlin/blob/master/pokekotlin/src/main/kotlin/me/sargunvohra/lib/pokekotlin/client/PokeApi.kt
  • API models: https://github.com/PokeAPI/pokekotlin/tree/master/pokekotlin/src/main/kotlin/me/sargunvohra/lib/pokekotlin/model

Let me know if you have any questions, so I know what’s most important to document.

sargunv avatar Nov 15 '17 19:11 sargunv

This'll be fun to have in the documentation if I ever get around to writing it: https://blog.jetbrains.com/kotlin/2018/04/embedding-kotlin-playground/

sargunv avatar May 06 '20 06:05 sargunv