Skip to content

Commit aec5296

Browse files
authored
Fix typos (#28)
1 parent bf83ac3 commit aec5296

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Connect-RPC ↔ ScalaPB GRPC Bridge
44

5-
This library provides a bridge between [Connect-RPC](https://connectrpc.com/docs/protocol) protocol and
5+
This library provides a bridge between [Connect](https://connectrpc.com/docs/protocol) protocol and
66
[ScalaPB](https://scalapb.github.io) GRPC compiler for Scala.
77
It is inspired and takes ideas from [grpc-json-bridge](https://github.com/avast/grpc-json-bridge) library, which doesn't
88
seem to be supported anymore + the library doesn't follow a Connect-RPC standard (while being very close to it),
@@ -26,14 +26,14 @@ So the most common approach is to expose REST APIs, which will be translated to
2626
There are two main protocols for this:
2727

2828
* [GRPC-WEB](https://github.com/grpc/grpc-web)
29-
* [Connect-RPC](https://connectrpc.com/docs/introduction)
29+
* [Connect](https://connectrpc.com/docs/introduction)
3030

31-
They are similar, but GRPC-WEB target is to be as close to GRPC as possible, while Connect-RPC is more
31+
They are similar, but GRPC-WEB target is to be as close to GRPC as possible, while Connect is more
3232
web-friendly: it has better client libraries, better web semantics:
3333
content-type is `application/json` instead of `application/grpc-web+json`, error codes are just normal http codes
3434
instead of being sent in headers, errors are output in the body of the response JSON-encoded, it supports GET-requests,
3535
etc (you can also read
36-
this [blog post describing why ConnectRPC is better](https://buf.build/blog/connect-a-better-grpc)).
36+
this [blog post describing why Connect is better](https://buf.build/blog/connect-a-better-grpc)).
3737

3838
Both protocols support encoding data in Protobuf and JSON.
3939
JSON is more web-friendly, but it requires having some component in the middle, providing JSON → Protobuf
@@ -51,7 +51,7 @@ To support JSON, Envoy needs to be configured with Protobuf descriptors, which i
5151
*That's where this library comes in*:
5252

5353
It allows exposing GRPC services, built with [ScalaPB](https://scalapb.github.io), to the clients
54-
using Connect-RPC protocol (with JSON messages), without Envoy or any other proxy, so a web service can expose
54+
using Connect protocol (with JSON messages), without Envoy or any other proxy, so a web service can expose
5555
both GRPC and REST APIs at the same time on two ports.
5656

5757
This simplifies overall setup: simpler CI, fewer network components, faster execution speed.
@@ -80,7 +80,7 @@ libraryDependencies ++= Seq(
8080
)
8181
```
8282

83-
After installing the library, you can expose your GRPC service to the clients using Connect-RPC protocol (suppose you
83+
After installing the library, you can expose your GRPC service to the clients using Connect protocol (suppose you
8484
already have a GRPC services generated with ScalaPB):
8585

8686
```scala
@@ -110,12 +110,12 @@ val httpServer: Resource[IO, org.http4s.server.Server] = {
110110
httpServer.use(_ => IO.never).unsafeRunSync()
111111
```
112112

113-
### Tip: GRPC Opentelemetry integration
113+
### Tip: GRPC OpenTelemetry integration
114114

115-
Since the library creates a separate "fake" grpc server, traffic going through it won't be captured by the
116-
instrumentation of the main grpc server.
115+
Since the library creates a separate "fake" GRPC server, traffic going through it won't be captured by the
116+
instrumentation of the main GRPC server.
117117

118-
Here is how you can integrate the Opentelemetry with the Connect-RPC server:
118+
Here is how you can integrate OpenTelemetry with the Connect-RPC server:
119119

120120
```scala
121121
val grpcServices: Seq[io.grpc.ServiceDefinition] = ??? // Your GRPC service(s)
@@ -154,7 +154,7 @@ Current status: 6/79 tests pass
154154

155155
Known issues:
156156

157-
* fs2-grpc server implementation doesn't support setting response headers
157+
* `fs2-grpc` server implementation doesn't support setting response headers (which is required by the tests)
158158
* `google.protobuf.Any` serialization doesn't follow Connect-RPC spec
159159

160160
## Future improvements

0 commit comments

Comments
 (0)