AI Documentation for Kotlin Projects
Hosted docs for Kotlin repos. Auto-generated, auto-updated nightly. Detects build.gradle.kts and multiplatform targets.
Free for public repos. No account needed.
What ReadmeBot detects in your project
ReadmeBot analyses your repository and automatically identifies key configuration files and project structure. Here are the files and patterns it looks for:
build.gradle.ktssrc/main/kotlin/settings.gradle.kts
What's included in your documentation
Based on what ReadmeBot finds in your repository, it generates structured documentation with the following sections tailored to your stack:
Prerequisites
Building with Gradle
Usage and examples
Testing
Contributing guidelines
Frequently asked questions
Does it understand Kotlin Multiplatform?
Yes. ReadmeBot detects KMP source sets and documents each platform target with its specific setup requirements.
Will it document coroutine usage?
If your project uses kotlinx.coroutines, ReadmeBot notes the concurrency model and any relevant dispatcher configuration.
Does it support Gradle Kotlin DSL?
ReadmeBot fully supports build.gradle.kts and parses it for dependencies, plugins, and build configuration.