Index: third_party/grpc/examples/objective-c/helloworld/README.md |
diff --git a/third_party/grpc/examples/objective-c/helloworld/README.md b/third_party/grpc/examples/objective-c/helloworld/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..81c5aaa7bcb4e665433d41bc924ab20ce3d52558 |
--- /dev/null |
+++ b/third_party/grpc/examples/objective-c/helloworld/README.md |
@@ -0,0 +1,58 @@ |
+#gRPC in 3 minutes (Objective-C) |
+ |
+## Installation |
+ |
+To run this example you should have [Cocoapods](https://cocoapods.org/#install) installed, as well |
+as the relevant tools to generate the client library code (and a server in another language, for |
+testing). You can obtain the latter by following [these setup instructions](https://github.com/grpc/homebrew-grpc). |
+ |
+## Hello Objective-C gRPC! |
+ |
+Here's how to build and run the Objective-C implementation of the [Hello World](../../protos/helloworld.proto) |
+example used in [Getting started](https://github.com/grpc/grpc/tree/master/examples). |
+ |
+The example code for this and our other examples lives in the `examples` directory. Clone |
+this repository to your local machine by running the following commands: |
+ |
+ |
+```sh |
+$ git clone https://github.com/grpc/grpc.git |
+$ cd grpc |
+$ git submodule update --init |
+``` |
+ |
+Change your current directory to `examples/objective-c/helloworld` |
+ |
+```sh |
+$ cd examples/objective-c/helloworld |
+``` |
+ |
+### Try it! |
+To try the sample app, we need a gRPC server running locally. Let's compile and run, for example, |
+the C++ server in this repository: |
+ |
+```shell |
+$ pushd ../../cpp/helloworld |
+$ make |
+$ ./greeter_server & |
+$ popd |
+``` |
+ |
+Now have Cocoapods generate and install the client library for our .proto files: |
+ |
+```shell |
+$ pod install |
+``` |
+ |
+(This might have to compile OpenSSL, which takes around 15 minutes if Cocoapods doesn't have it yet |
+on your computer's cache.) |
+ |
+Finally, open the XCode workspace created by Cocoapods, and run the app. You can check the calling |
+code in `main.m` and see the results in XCode's log console. |
+ |
+The code sends a `HLWHelloRequest` containing the string "Objective-C" to a local server. The server |
+responds with a `HLWHelloResponse`, which contains a string that is then output to the log. |
+ |
+## Tutorial |
+ |
+You can find a more detailed tutorial in [gRPC Basics: Objective-C](http://www.grpc.io/docs/tutorials/basic/objective-c.html). |