Skip to content

Commit a07d96c

Browse files
authored
Update README.md (#77)
1 parent e2a2269 commit a07d96c

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Diff for: README.md

+4
Original file line numberDiff line numberDiff line change
@@ -652,6 +652,10 @@ The examples also demonstrate testing using [jest](https://jestjs.io/).
652652
653653
## Caveats, Warnings and Issues ⚠️
654654
655+
### Protobuf2
656+
657+
This library supports Protobuf3. Protobuf2 should work, with the notable exception of [Groups](https://developers.google.com/protocol-buffers/docs/proto#groups) which have not been implemented. If you encounter any issues with Protobuf2 or need `Group` support, please open an issue.
658+
655659
### JavaScript Servers (does not apply to servers written in TypeScript)
656660
657661
JavaScript Server implementations require special consideration. The Node.js ecosystem is in a transition period from CommonJS to modules. TwirpScript generates JavaScript modules to enable tree shaking for clients. This means that Node.js servers either need to [opt-in to modules](https://nodejs.org/api/esm.html#esm_enabling), or use a bundler like Webpack or ESBuild. See the [JavaScript fullstack](https://github.com/tatethurston/twirpscript/blob/main/examples/typescript-fullstack) to see what this looks like.

0 commit comments

Comments
 (0)