diff --git a/README.md b/README.md index 45a687d..38e71c8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -# Kotlin LSIF indexer -![status: development](https://camo.githubusercontent.com/27137af2d15ae2e5af54fb7ec1081e001370f021901724d630e23003990b08c5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7374617475732d646576656c6f706d656e742d79656c6c6f773f7374796c653d666c6174) +# Kotlin LSIF support -This project implements a Kotlin compiler plugin that generates an LSIF index from a project, using [SemanticDB](https://scalameta.org/docs/semanticdb/guide.html) as an intermediary format. +This codebase implements a Kotlin compiler plugin that can be used together with +[lsif-java](https://sourcegraph.github.io/lsif-java) to emit +[LSIF](https://lsif.dev) indexes for Kotlin projects. -It is still highly under development, and as such includes no install/usage instructions. +## Getting started -Visit [lsif.dev](https://lsif.dev) to learn about LSIF. +This project must be used together with lsif-java. Visit +[https://sourcegraph.github.io/lsif-java/] for instructions on how to index +Kotlin projects with lsif-java. Note that lsif-java indexes Kotlin sources even +if you have no Java code.