Skip to content

Commit

Permalink
Docs: Updated documentation on runtime and noparse builds
Browse files Browse the repository at this point in the history
  • Loading branch information
dcodeIO committed Dec 23, 2016
1 parent 4424713 commit 4d1f5fa
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 7 deletions.
2 changes: 1 addition & 1 deletion dist/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
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.

Alternatively, you can also use [the minimal runtime](./runtime) when working with statically generated code from `pbjs` *only*.
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*.

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

Expand Down
4 changes: 1 addition & 3 deletions dist/noparse/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
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.

**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.
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`.

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

Expand Down
4 changes: 1 addition & 3 deletions dist/runtime/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
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.

**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.
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`.

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

Expand Down

0 comments on commit 4d1f5fa

Please sign in to comment.