aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEric Anderson <ejona@google.com>2016-06-14 10:58:38 -0700
committerGitHub <noreply@github.com>2016-06-14 10:58:38 -0700
commita62e9762299eff3f4d29484f1e8db46358241c9b (patch)
tree9e099c30ec769bc170d196a1d613c8e10ca9c777 /README.md
parenta2076f4ec8e6b4eea822fcc2b27798ea0b670d4f (diff)
downloadgrpc-grpc-java-a62e9762299eff3f4d29484f1e8db46358241c9b.tar.gz
docs: Don't suggest using grpc-all
Using grpc-all pulls in more dependencies than necessary, as virtually no user needs both OkHttp and Netty or both Protobuf and Protobuf Nano. When the separate deps are listed, users are much more likely to remove unnecessary deps. Fixes #1597
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 18 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7a8e2f589..51d9e4e87 100644
--- a/README.md
+++ b/README.md
@@ -22,21 +22,34 @@ Readme](SECURITY.md).
Download
--------
-Download [the JARs][]. Or for Maven, add to your `pom.xml`:
+Download [the JARs][]. Or for Maven with non-Android, add to your `pom.xml`:
```xml
<dependency>
<groupId>io.grpc</groupId>
- <artifactId>grpc-all</artifactId>
+ <artifactId>grpc-netty</artifactId>
+ <version>0.14.0</version>
+</dependency>
+<dependency>
+ <groupId>io.grpc</groupId>
+ <artifactId>grpc-protobuf</artifactId>
+ <version>0.14.0</version>
+</dependency>
+<dependency>
+ <groupId>io.grpc</groupId>
+ <artifactId>grpc-stub</artifactId>
<version>0.14.0</version>
</dependency>
```
-Or for Gradle, add to your dependencies:
+Or for Gradle with non-Android, add to your dependencies:
```gradle
-compile 'io.grpc:grpc-all:0.14.0'
+compile 'io.grpc:grpc-netty:0.14.0'
+compile 'io.grpc:grpc-protobuf:0.14.0'
+compile 'io.grpc:grpc-stub:0.14.0'
```
-For Android client, you only need to depend on the needed sub-projects, such as:
+For Android client, use `grpc-okhttp` instead of `grpc-netty` and
+`grpc-protobuf-nano` or `grpc-protobuf-lite` instead of `grpc-protobuf`:
```gradle
compile 'io.grpc:grpc-okhttp:0.14.0'
compile 'io.grpc:grpc-protobuf-nano:0.14.0'