Commit f97322bc authored by Aral Balkan's avatar Aral Balkan
Browse files

Update changelog and readme

parent f82a783c
......@@ -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.
......
......@@ -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>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment