Skip to content

Commit

Permalink
Adjectives, notes on browserify [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
dcodeIO committed Dec 2, 2016
1 parent d9634d2 commit fce8276
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ protobuf.js [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [
[paypal-image]: https://img.shields.io/badge/paypal-donate-yellow.svg
[paypal-url]: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=dcode%40dcode.io&item_name=%3C3%20protobuf.js

Features
--------
* Rapid [runtime code generation](#performance)
* Exhaustive [browser support](#compatibility)
* Managed [TypeScript support](#usage-with-typescript)
* Elaborate [documentation](#documentation)
* Convenient [CLI utilities](#command-line)
* Seamless [browserify integration](#browserify-integration)

Contents
--------

Expand Down Expand Up @@ -342,6 +351,15 @@ Building the TypeScript definition to `types/`:
$> npm run types
```

### Browserify integration

protobuf.js integrates seamlessly into your browserify build-process. There are a few optional tweaks, though:

* 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.
* If you do not need int64 support, you can exclude the `long` module.
* 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`.
* If you have any special requirements, there is [the bundler](https://github.com/dcodeIO/protobuf.js/blob/master/scripts/bundle.js) as a reference.

Performance
-----------
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:
Expand Down

0 comments on commit fce8276

Please sign in to comment.