Skip to content

Commit fce8276

Browse files
committed
Adjectives, notes on browserify [ci skip]
1 parent d9634d2 commit fce8276

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ protobuf.js [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [
1212
[paypal-image]: https://img.shields.io/badge/paypal-donate-yellow.svg
1313
[paypal-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=dcode%40dcode.io&item_name=%3C3%20protobuf.js
1414

15+
Features
16+
--------
17+
* Rapid [runtime code generation](#performance)
18+
* Exhaustive [browser support](#compatibility)
19+
* Managed [TypeScript support](#usage-with-typescript)
20+
* Elaborate [documentation](#documentation)
21+
* Convenient [CLI utilities](#command-line)
22+
* Seamless [browserify integration](#browserify-integration)
23+
1524
Contents
1625
--------
1726

@@ -342,6 +351,15 @@ Building the TypeScript definition to `types/`:
342351
$> npm run types
343352
```
344353

354+
### Browserify integration
355+
356+
protobuf.js integrates seamlessly into your browserify build-process. There are a few optional tweaks, though:
357+
358+
* If performance is a concern or IE8 support is required, you should make sure to exclude the browserified `buffer` module and let protobuf.js do its thing with Uint8Array/Array instead.
359+
* If you do not need int64 support, you can exclude the `long` module.
360+
* If your application does not rely on the following modules and/or package size is a concern, you can also exclude `process` , `_process` and `fs`.
361+
* If you have any special requirements, there is [the bundler](https://github.com/dcodeIO/protobuf.js/blob/master/scripts/bundle.js) as a reference.
362+
345363
Performance
346364
-----------
347365
The package includes a [benchmark](https://github.com/dcodeIO/protobuf.js/tree/master/bench) that tries to compare performance to native JSON as far as this is possible. On an i7-2600K running node 6.9.1 it yields:

0 commit comments

Comments
 (0)