Skip to content

Commit

Permalink
Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
smaye81 committed Nov 11, 2024
1 parent 3d71eff commit 136c5c5
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,16 @@ the builtin `http` and `http2` modules.

## Migrating from version 1

Version 2 provides many new features and simplifies some common APIs. In addition,
Version 2 provides new features and simplifies some common APIs. In addition,
it makes use of all the enhancements of Protobuf-ES v2. To upgrade, you'll need
to update your dependencies, re-generate code, and update call sites in your application.
to update your dependencies, re-generate code, and update callsites in your application.

The first thing to be aware of is that the plugin `protoc-gen-connect-es` has been
removed in v2. Connect now relies on descriptors generated by Protobuf-ES v2.
When upgrading, you will first need to remove any usage of this plugin. For most
users, this means a combination of any of the following steps:

* Remove `protoc-gen-connect-es` from their `package.json` either manually or
* Remove `protoc-gen-connect-es` from `package.json` either manually or
via a package manager, i.e. `npm uninstall @connectrpc/protoc-gen-connect-es`.

* Remove any usage of the plugin in `buf.gen.yaml`.
Expand All @@ -96,8 +96,8 @@ dependencies you have on its relevant packages:
npm install @bufbuild/protobuf@^2.0.0 @bufbuild/protoc-gen-es@^2.0.0
```

Finally, update the [packages](#packages) you use with your package manager of choice.
For example, with NPM:
Finally, update the Connect [packages](#packages) you use with your package
manager of choice. For example, with NPM:

```shellsession
npm install @connectrpc/connect@^2.0.0 @connectrpc/connect-web@^2.0.0
Expand All @@ -110,7 +110,7 @@ be aware of:

* The gRPC Transport now requires HTTP/2. If you are using `createGrpcTransport`
and specifying an `httpVersion`, it will fail compilation. Remove the
`httpVersion` property to use the default.
`httpVersion` property to use the default of HTTP/2.

Note that if you were relying on HTTP/1.1 as part of your gRPC strategy, this
may require bigger architectural changes, but the hope is that this is not a
Expand Down Expand Up @@ -149,7 +149,7 @@ be aware of:
client.requestA(new MessageB())
```

This was an unintended bug and not a feature and in Connect v2, only the specified
This was an unintended bug and not a feature. In Connect v2, only the specified
target type will pass compilation.

* We have removed the `credentials` option from transports as well as the `init`
Expand Down Expand Up @@ -228,7 +228,7 @@ be aware of:
v1, the server used more exact types in interceptors, for example `UnaryRequest`
for server-streaming rpcs while the client always used streaming variants.
This was unintended behavior and has been fixed in v2. Now all streaming RPCs
use the `StreamRequest` and `StreamResponse` on the server as well.
use the `StreamRequest` and `StreamResponse` types on the server as well.

## Other platforms

Expand Down

0 comments on commit 136c5c5

Please sign in to comment.