aboutsummaryrefslogtreecommitdiff
path: root/examples/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/README.md')
-rw-r--r--examples/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md
new file mode 100644
index 000000000..8832bb0ae
--- /dev/null
+++ b/examples/README.md
@@ -0,0 +1,22 @@
+grpc Examples
+==============================================
+
+In order to run the examples simply execute one of the gradle tasks `mathserver`, `mathclient`,
+`stockserver` or `stockclient`.
+
+For example, say you want to play around with the math examples. First you want to start
+the server and then have the client connect to it and do some fun calculations.
+
+Assuming you are in the grpc-java root folder you would first start the math server by running
+
+```
+$ ./gradlew :grpc-examples:mathserver
+```
+
+and in a different terminal window then run the client by typing
+
+```
+$ ./gradlew :grpc-examples:mathclient
+```
+
+That's it!