Consider providing GH-pages hosted API reference

russhwolf / multiplatform-settings

A Kotlin Multiplatform library for saving simple key-value data

Apache License 2.0

1.58k stars 67 forks source link

Consider providing GH-pages hosted API reference #198

Open qwwdfsad opened 2 months ago

qwwdfsad commented 2 months ago

It would be nice to have an API reference (similar to e.g. https://kotlin.github.io/kotlinx-io/) available out of the box with the overview of the whole API surface with the documentation and, ideally, small samples provided

russhwolf commented 2 weeks ago

This has been in the back of my head (and hidden in the readme) as a todo for a while, but haven't had the time for it. Good to have it tracked explicitly