Skip to content

Commit 4d1f5fa

Browse files
committed
Docs: Updated documentation on runtime and noparse builds
1 parent 4424713 commit 4d1f5fa

File tree

3 files changed

+3
-7
lines changed

3 files changed

+3
-7
lines changed

dist/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
This folder contains prebuilt browser versions of [protobuf.js](https://github.com/dcodeIO/protobuf.js). When sending pull requests, it is not required to update these.
22

3-
Alternatively, you can also use [the minimal runtime](./runtime) when working with statically generated code from `pbjs` *only*.
3+
Alternatively, you can also use [the minimal runtime](./runtime) when working with statically generated code or [the noparse build](./noparse) when working with JSON generated by `pbjs` *only*.
44

55
Prebuilt files are in source control to enable pain-free frontend respectively CDN usage:
66

dist/noparse/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
This folder contains prebuilt browser versions of [protobuf.js](https://github.com/dcodeIO/protobuf.js) without the .proto parser. When sending pull requests, it is not required to update these.
2-
3-
**NOTE:** This slightly smaller version of the full library can be used as a drop-in replacment where .proto parsing is not required, i.e. when only working with JSON files generated by pbjs as recommended for production.
1+
This slightly smaller version of the full library can be used as a drop-in replacment where .proto parsing is not required, i.e. when only working with JSON files generated by pbjs as recommended for production. To achieve the same with browserify, simply [exclude](https://github.com/substack/browserify-handbook#excluding) `./tokenize` and `./parse`.
42

53
Prebuilt files are in source control to enable pain-free frontend respectively CDN usage:
64

dist/runtime/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
This folder contains prebuilt browser versions of [protobuf.js](https://github.com/dcodeIO/protobuf.js)'s minimal runtime for statically generated code. When sending pull requests, it is not required to update these.
2-
3-
**NOTE:** The minimal runtime includes just the bare minimum required to work with statically generated code - and *nothing else*. Where applicable, it can be used as a drop-in replacement for the full library as it has the same general structure.
1+
The minimal runtime includes just the bare minimum required to work with statically generated code - and *nothing else*. Where applicable, it can be used as a drop-in replacement for the full library as it has the same general structure. To achieve the same with browserify, simply depend on `protobufjs/runtime` instead of `protobufjs`.
42

53
Prebuilt files are in source control to enable pain-free frontend respectively CDN usage:
64

0 commit comments

Comments
 (0)