aboutsummaryrefslogtreecommitdiffhomepage
path: root/tools/grift/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/grift/README.md')
-rw-r--r--tools/grift/README.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/tools/grift/README.md b/tools/grift/README.md
index 7cbbdc567b..2b5fa5ae14 100644
--- a/tools/grift/README.md
+++ b/tools/grift/README.md
@@ -1,6 +1,4 @@
-Copyright 2016 Google Inc.
-
-#Documentation
+# Documentation
grift is integration of [Apache Thrift](https://github.com/apache/thrift.git) Serializer with gRPC.
@@ -8,19 +6,19 @@ This integration allows you to use grpc to send thrift messages in C++ and java.
grift uses Compact Protocol to serialize thrift messages.
-##generating grpc plugins for thrift services
+## generating grpc plugins for thrift services
-###CPP
+### C++
```sh
$ thrift --gen cpp <thrift-file>
```
-###JAVA
+### Java
```sh
$ thrift --gen java <thrift-file>
```
-#Installation
+# Installation
Before Installing thrift make sure to apply this [patch](grpc_plugins_generator.patch) to third_party/thrift.
Go to third_party/thrift and follow the [INSTALLATION](https://github.com/apache/thrift.git) instructions to install thrift with commit id bcad91771b7f0bff28a1cac1981d7ef2b9bcef3c. \ No newline at end of file