Skip to content

Commit df91010

Browse files
authored
Improve examples readme (#326)
1 parent dc319db commit df91010

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

examples/README.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,21 @@ Examples of basic gRPC scenarios with gRPC for .NET.
55
* [Clients](./Clients) - each example has its own client
66
* [Server](./Server) - a shared website that hosts all services
77

8+
If you are brand new to gRPC on .NET a good place to start is the getting started tutorial: [Create a gRPC client and server in ASP.NET Core](https://docs.microsoft.com/aspnet/core/tutorials/grpc/grpc-start)
9+
810
## Greeter
911

10-
The greeter shows how to make unary and server streaming gRPC methods and call them from a client.
12+
The greeter shows how to create unary (non-streaming) and server streaming gRPC methods in ASP.NET Core, and call them from a client.
1113

1214
##### Scenarios:
1315

1416
* Unary call
1517
* Server streaming call
16-
* Client canceling a streaming call
18+
* Client canceling a call
1719

1820
## Counter
1921

20-
The counter shows how to make unary and client streaming gRPC methods and call them from a client.
22+
The counter shows how to create unary (non-streaming) and client streaming gRPC methods in ASP.NET Core, and call them from a client.
2123

2224
##### Scenarios:
2325

@@ -26,7 +28,7 @@ The counter shows how to make unary and client streaming gRPC methods and call t
2628

2729
## Mailer
2830

29-
The mailer shows how to make bi-directional streaming gRPC methods and call them from a client.
31+
The mailer shows how to create a bi-directional streaming gRPC method in ASP.NET Core and call it from a client.
3032

3133
##### Scenarios:
3234

@@ -39,7 +41,8 @@ The ticketer shows how to use gRPC with [authentication and authorization in ASP
3941
##### Scenarios:
4042

4143
* JSON web token authentication
42-
* Authorization with attribute on service
44+
* Send JWT token with call
45+
* Authorization with `[Authorize]` on service
4346

4447
## Reflector
4548

@@ -56,14 +59,14 @@ The certifier shows how to configure the client and the server to use a [TLS cli
5659

5760
##### Scenarios:
5861

62+
* Client certificate authentication
5963
* Send client certificate with call
6064
* Receive client certificate in a service
61-
* Client certificate authentication
62-
* Authorization with attribute on service
65+
* Authorization with `[Authorize]` on service
6366

6467
## Worker
6568

66-
The worker shows how a [worker service](https://devblogs.microsoft.com/aspnet/net-core-workers-as-windows-services/) can use the gRPC client factory to make gRPC calls.
69+
The worker shows how a [.NET worker service](https://devblogs.microsoft.com/aspnet/net-core-workers-as-windows-services/) can use the gRPC client factory to make gRPC calls.
6770

6871
##### Scenarios:
6972

@@ -72,10 +75,10 @@ The worker shows how a [worker service](https://devblogs.microsoft.com/aspnet/ne
7275

7376
## Aggregator
7477

75-
The aggregator shows how a to use the gRPC client factory with services to make nested gRPC calls. The gRPC client factory is configured to propagate the context from the original call to the nested call. For example, cancellation will automatically propagate.
78+
The aggregator shows how a to make nested gRPC calls (a gRPC service calling another gRPC service). The gRPC client factory is used in ASP.NET Core to inject a client into services. The gRPC client factory is configured to propagate the context from the original call to the nested call. In this example the cancellation from the client will automatically propagate through to nested gRPC calls.
7679

7780
##### Scenarios:
7881

7982
* Client factory
80-
* Client canceling a streaming call
81-
* Context propagation
83+
* Client canceling a call
84+
* Cancellation propagation

0 commit comments

Comments
 (0)