From 4d1f5facfcaaf5f2ab6a70b12443ff1b66e7b94e Mon Sep 17 00:00:00 2001 From: dcodeIO Date: Fri, 23 Dec 2016 11:47:40 +0100 Subject: [PATCH] Docs: Updated documentation on runtime and noparse builds --- dist/README.md | 2 +- dist/noparse/README.md | 4 +--- dist/runtime/README.md | 4 +--- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/dist/README.md b/dist/README.md index 7af4da7b3..964df9a71 100644 --- a/dist/README.md +++ b/dist/README.md @@ -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: diff --git a/dist/noparse/README.md b/dist/noparse/README.md index 952ab5bc8..3347f35ef 100644 --- a/dist/noparse/README.md +++ b/dist/noparse/README.md @@ -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: diff --git a/dist/runtime/README.md b/dist/runtime/README.md index 2d468c220..45979c650 100644 --- a/dist/runtime/README.md +++ b/dist/runtime/README.md @@ -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: