aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorronshapiro <ronshapiro@google.com>2019-08-23 08:49:53 -0700
committerChris Povirk <beigetangerine@gmail.com>2019-08-23 14:23:31 -0400
commitc7b835923ff09e93cb997692d8b9bbca53a00f68 (patch)
treeae773c567d89da21eaf20a6d10689065821daed1 /README.md
parenta8a00fa96d0a2b661b9e2f05bbc91e091e978d14 (diff)
downloaddagger2-c7b835923ff09e93cb997692d8b9bbca53a00f68.tar.gz
Update Gradle documentation
- Java Gradle and Android Gradle are now merged - `compile` is replaced with `api`, and links are added for more information so that advanced usage can consider using `implementation` - Mention kapt This may not be perfect, but it's long overdue. Now we can at least iterate on it. Closes https://github.com/google/dagger/pull/1130 Closes https://github.com/google/dagger/issues/1423 ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=265063658
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 16 insertions, 20 deletions
diff --git a/README.md b/README.md
index 01407f428..e5c1de5e4 100644
--- a/README.md
+++ b/README.md
@@ -113,25 +113,11 @@ parallelizable execution graphs), then add this to your maven configuration:
</dependencies>
```
-#### Java Gradle
+#### Gradle
```groovy
-// Add plugin https://plugins.gradle.org/plugin/net.ltgt.apt
-plugins {
- id "net.ltgt.apt" version "0.10"
-}
-
// Add Dagger dependencies
dependencies {
- compile 'com.google.dagger:dagger:2.x'
- apt 'com.google.dagger:dagger-compiler:2.x'
-}
-```
-
-#### Android Gradle
-```groovy
-// Add Dagger dependencies
-dependencies {
- compile 'com.google.dagger:dagger:2.x'
+ api 'com.google.dagger:dagger:2.x'
annotationProcessor 'com.google.dagger:dagger-compiler:2.x'
}
```
@@ -139,13 +125,20 @@ dependencies {
If you're using classes in `dagger.android` you'll also want to include:
```groovy
-compile 'com.google.dagger:dagger-android:2.x'
-compile 'com.google.dagger:dagger-android-support:2.x' // if you use the support libraries
+api 'com.google.dagger:dagger-android:2.x'
+api 'com.google.dagger:dagger-android-support:2.x' // if you use the support libraries
annotationProcessor 'com.google.dagger:dagger-android-processor:2.x'
```
-If you're using a version of the Android gradle plugin below `2.2`, see
-https://bitbucket.org/hvisser/android-apt.
+Notes:
+
+- Some projects will want to use `implementation` instead of `api` for better
+ compilation performance.
+ - See the [Gradle documentation][gradle-api-implementation] for more
+ information on how to select appropriately, and the [Android Gradle
+ plugin documentation][gradle-api-implementation-android] for Android
+ projects.
+- For Kotlin projects, use [`kapt`] in place of `annotationProcessor`.
If you're using the [Android Databinding library][databinding], you may want to
increase the number of errors that `javac` will print. When Dagger prints an
@@ -203,7 +196,10 @@ See [the CONTRIBUTING.md docs][Building Dagger].
[databinding]: https://developer.android.com/topic/libraries/data-binding/
[gaktalk]: https://www.youtube.com/watch?v=oK_XtfXPkqw
[GitHub Issues]: https://github.com/google/dagger/issues
+[gradle-api-implementation]: https://docs.gradle.org/current/userguide/java_library_plugin.html#sec:java_library_separation
+[gradle-api-implementation-android]: https://developer.android.com/studio/build/dependencies#dependency_configurations
[Guava]: https://github.com/google/guava
+[`kapt`]: https://kotlinlang.org/docs/reference/kapt.html
[latestapi]: https://dagger.dev/api/latest/
[mavenbadge-svg]: https://maven-badges.herokuapp.com/maven-central/com.google.dagger/dagger/badge.svg
[mavencentral]: https://search.maven.org/artifact/com.google.dagger/dagger