From d6c57a576c5ff378143403c5fe85c7dc8dd9a9c1 Mon Sep 17 00:00:00 2001 From: David Winer Date: Wed, 3 Feb 2021 12:58:39 -0800 Subject: [PATCH] Add library support table and other doc updates 1. Library support table 2. Update README to include latest speedup stats (up to 2x) 3. Fix broken playground link in quickstart --- README.md | 19 ++++++++++++++++--- docs/quickstart.md | 2 +- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c1a0253aae..a4538d30c3 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ Kotlin Symbol Processing (KSP) is an API that you can use to develop lightweight compiler plugins. KSP provides a simplified compiler plugin API that leverages the power of Kotlin while keeping the learning curve at -a minimum. Compared to KAPT, annotation processors that use KSP can run 25% faster. +a minimum. Compared to KAPT, annotation processors that use KSP can run up to 2x faster. -Here are more details on [why considering KSP](/docs/why-ksp.md) over other alternatives. +To learn more about how KSP compares to KAPT, check out [why KSP](/docs/why-ksp.md). To get started writing a KSP processor, take a look at the [KSP quickstart](/docs/quickstart.md). ## Overview @@ -162,4 +162,17 @@ or connecting with our team in the `#ksp` channel in the Here are some planned features that have not yet been implemented: * Make the IDE aware of the generated code. -* Support Kotlin Multiplatform. \ No newline at end of file +* Support Kotlin Multiplatform. + +## Supported libraries + +The table below includes a list of popular libraries on Android and their various stages of support for KSP. If your library is missing, please feel free to submit a pull request. + +|Library|Status|Tracking issue for KSP| +|---|---|---| +|Room|In progress|[Link](https://issuetracker.google.com/160322705)| +|Moshi|[Experimentally supported](https://github.com/ZacSweers/MoshiX/tree/main/moshi-ksp)| | +|Auto Factory|Not yet supported|[Link](https://github.com/google/auto/issues/982)| +|Dagger|Not yet supported|[Link](https://github.com/google/dagger/issues/2349)| +|Hilt|Not yet supported|[Link](https://issuetracker.google.com/179057202)| +|Glide|Not yet supported|[Link](https://github.com/bumptech/glide/issues/4492)| \ No newline at end of file diff --git a/docs/quickstart.md b/docs/quickstart.md index 5048c68fe9..9da2a8ae87 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,6 +1,6 @@ # Quickstart -Here's a sample processor that you can check out: https://github.com/google/ksp/releases/download/1.4.20-dev-experimental-20210120/playground-ksp-1.4.20-dev-experimental-20210120.zip +[Here's](https://github.com/google/ksp/releases/download/1.4.20-dev-experimental-20210120/playground.zip) a sample processor that you can check out. ## Create a processor of your own