aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/python
diff options
context:
space:
mode:
authorGravatar Nathaniel Manista <nathaniel@google.com>2015-06-10 10:43:47 -0700
committerGravatar Nathaniel Manista <nathaniel@google.com>2015-06-10 10:43:47 -0700
commita08694eff2a036b68f8bd0172d2eb0d16d560bb7 (patch)
tree4c1f3d311947916829ae72b8dec367bfd3f0cf96 /src/python
parent145fb8f37bb608cb82a1dc4097129106ff67ca6f (diff)
parent05aafbc9d9f218d99dbe4f93d0f62ebf0380b26c (diff)
Merge pull request #2033 from tbetbetbe/grpc-python-update-add-example-to-docs
Update src/python/README.md to link to quick start and detailed example documentation.
Diffstat (limited to 'src/python')
-rw-r--r--src/python/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/python/README.md b/src/python/README.md
index 0bca457a33..2beb3a913a 100644
--- a/src/python/README.md
+++ b/src/python/README.md
@@ -20,6 +20,10 @@ $ curl -fsSL https://goo.gl/getgrpc | bash -s python
```
This will download and run the [gRPC install script][], then install the latest version of the gRPC Python package. It also installs the Protocol Buffers compiler (_protoc_) and the gRPC _protoc_ plugin for python.
+EXAMPLES
+--------
+Please read our online documentation for a [Quick Start][] and a [detailed example][]
+
BUILDING FROM SOURCE
---------------------
- Clone this repository
@@ -58,3 +62,5 @@ $ ../../tools/distrib/python/submit.py
[homebrew]:http://brew.sh
[linuxbrew]:https://github.com/Homebrew/linuxbrew#installation
[gRPC install script]:https://raw.githubusercontent.com/grpc/homebrew-grpc/master/scripts/install
+[Quick Start]:http://www.grpc.io/docs/tutorials/basic/python.html
+[detailed example]:http://www.grpc.io/docs/installation/python.html