Skip to content

Commit

Permalink
Add library support table and other doc updates
Browse files Browse the repository at this point in the history
1. Library support table
2. Update README to include latest speedup stats (up to 2x)
3. Fix broken playground link in quickstart
  • Loading branch information
davidjwiner authored and ting-yuan committed Feb 3, 2021
1 parent b756b91 commit d6c57a5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
* 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)|
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit d6c57a5

Please sign in to comment.