Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add installation instructions to index.md #44

Merged
merged 1 commit into from
Feb 9, 2023
Merged

Add installation instructions to index.md #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,18 @@ Compose has lots of superpowers but also has a bunch of footguns to be aware of

This is where our static checks come in. We want to detect as many potential issues as we can, as quickly as we can. In this case we want an error to show prior to engineers having to review code. Similar to other static check libraries we hope this leads to a "don't shoot the messengers" philosophy which will foster healthy Compose adoption.

## Installation

Just add the dependency to the `lintChecks` configuration. Note for non-android projects, you must apply the `com.android.lint` Gradle plugin to use this.

[![Maven Central](https://img.shields.io/maven-central/v/com.slack.lint.compose/compose-lint-checks.svg)](https://mvnrepository.com/artifact/com.slack.lint.compose/compose-lint-checks)

```kotlin
dependencies {
chrisbanes marked this conversation as resolved.
Show resolved Hide resolved
lintChecks("com.slack.lint.compose:compose-lint-checks:<version>")
}
```

License
--------

Expand Down