Skip to content

Add note about native zlib module to readme #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tobiasmuehl wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add note about native zlib module to readme #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,16 @@ with Emscripten. The original C++ source code can be found [here](http://github

## Installation and usage

### NodeJS

_Update_: Node has its own [brotli implementation](https://nodejs.org/api/zlib.html#zlib_zlib_brotlicompress_buffer_options_callback) as part of the `zlib` module that should be used instead.

Install using npm.

npm install brotli

### Browser

If you want to use brotli in the browser, you should use [Browserify](http://browserify.org/) to build it.

In node, or in browserify, you can load brotli in the standard way:
Expand Down