Skip to content

Commit d0d2c1e

Browse files
authored
docs: add links to examples and tutorials. (grpc#2614)
1 parent d87a658 commit d0d2c1e

3 files changed

Lines changed: 17 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,10 @@ gRPC comes with three Transport implementations:
230230
* [Server Stream Listener](https://github.com/google/grpc-java/blob/master/core/src/main/java/io/grpc/internal/ServerStreamListener.java)
231231

232232

233-
### Examples
233+
Examples
234+
--------
234235

235-
Tests showing how these layers are composed to execute calls using protobuf
236-
messages can be found here
237-
https://github.com/google/grpc-java/tree/master/interop-testing/src/main/java/io/grpc/testing/integration
236+
The [examples](https://github.com/grpc/grpc-java/tree/master/examples)
237+
and the
238+
[Android example](https://github.com/grpc/grpc-java/tree/master/examples/android) are standalone projects that
239+
showcase the usage of gRPC.

examples/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ The examples require grpc-java to already be built. You are strongly encouraged
55
to check out a git release tag, since there will already be a build of grpc
66
available. Otherwise you must follow [COMPILING](../COMPILING.md).
77

8+
You may want to read through the
9+
[Quick Start Guide](http://www.grpc.io/docs/quickstart/java.html)
10+
before trying out the examples.
11+
812
To build the examples, run in this directory:
913

1014
```

examples/android/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
gRPC Hello World Tutorial (Android Java)
1+
gRPC Hello World Example (Android Java)
22
========================
33

44
PREREQUISITES
@@ -7,6 +7,8 @@ PREREQUISITES
77

88
- [Android Tutorial](https://developer.android.com/training/basics/firstapp/index.html) if you're new to Android development
99

10+
- [gRPC Java Android Quick Start Guide](http://www.grpc.io/docs/quickstart/android.html)
11+
1012
- We only have Android gRPC client in this example. Please follow examples in other languages to build and run a gRPC server.
1113

1214
INSTALL
@@ -24,3 +26,7 @@ $ cd examples/android
2426
$ cd helloworld # or "cd routeguide"
2527
$ ./gradlew installDebug
2628
```
29+
30+
Please refer to the
31+
[tutorial](http://www.grpc.io/docs/tutorials/basic/android.html) on
32+
how to use gRPC in Android programs.

0 commit comments

Comments
 (0)