docs: updated example docs

lewnelson · Jan 26, 2023 · 5fc75aa · 5fc75aa
1 parent 2478a44
commit 5fc75aa
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -1,3 +1,9 @@
 # Examples
 
+The code inside `generated/` was created with the following command:
+
+```bash
+npx grpc-ts generate ./example.proto ./generated
+```
+
 - [Using the generated client](./generated_client/README.md)
diff --git a/examples/generated_client/README.md b/examples/generated_client/README.md
@@ -3,3 +3,8 @@
 The `grpc-ts` CLI tool will generate the output from [grpc-tools](https://www.npmjs.com/package/grpc-tools) as well as creating a client class which uses the [GenericClient](../generic_client/README.md) under the hood to make requests.
 
 The client class method names are a 1:1 mapping of the methods defined in the generated client class on the `_grpc_pb.d.ts` files.
+
+- [Bidirectional streaming](./bidirectionalStreaming.ts)
+- [Client streaming](./clientStreaming.ts)
+- [Server streaming](./serverStreaming.ts)
+- [Unary requests](./unaryRequests.ts)