Skip to content

Commit

Permalink
List pros/cons.
Browse files Browse the repository at this point in the history
  • Loading branch information
sorccu committed Nov 6, 2016
1 parent 118cd8f commit f50ba27
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

## Benefits/philosophy

### Pros

* Leave legacy cruft behind. Only support most recent Node in [*active* Long-term Support](https://github.com/nodejs/LTS#lts-schedule) (currently v4) and newer.
- Take advantage of [ES2015 and later features](http://node.green/) (but don't require `--harmony` flag).
* Configuration is code with sensible defaults.
Expand All @@ -20,6 +22,18 @@
* Minimal bloat-free implementation.
* Dependency free!

### Cons

The current limitations are as follows.

* Not compatible with old Node.js versions.
- Your module won't be either.
* Does not yet support `http_proxy` and friends.
* Does not support overriding hosted binary location at install time.
* Does not support multiple files (e.g. generated artifacts) per binding.

If any of these is a deal-breaker, you might want to consider [node-pre-gyp](https://github.com/mapbox/node-pre-gyp) instead.

## Installation

Do not install `prebuilt-bindings` globally. Do the following to add it to your package instead.
Expand Down

0 comments on commit f50ba27

Please sign in to comment.