Skip to content

Commit

Permalink
Update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aral committed Mar 7, 2021
1 parent f82a783 commit f97322b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

- __Breaking change:__ Binaries are no longer bundled in the package. They are downloaded as an npm postinstall task.
- Uses ECMAScript Modules (ESM; es6 modules).
- Zero runtime dependencies.
- Dev: now using @small-tech/esm-tape-runner.
- Dev: now using c8 instead of nyc for coverage.
- Dev: replaced tap-spec and tap-nyc with @small-tech/tap-monkey.
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ npm i @small-tech/node-pebble

As part of the post-installation process, Node Pebble will download the correct Pebble binary for your platform for use at runtime.

Node Pebble has zero runtime dependencies.

## API

### Pebble.ready ([args], [env]) -> Promise<ChildProcess>
Expand Down

0 comments on commit f97322b

Please sign in to comment.