flocore-node/RELEASE.md
Chris Kleeschulte a62410da67 Spacing, RELEASE notes, clean up
- Removed main Makefile
- Fixed wording in README
- Altered build script
- Fixed clean script
2015-08-05 16:29:30 -04:00

36 lines
1.1 KiB
Markdown

Bitcore Node
=======
A Node.js module that adds a native interface to Bitcoin Core for querying information about the Bitcoin blockchain. Bindings are linked to Bitcore Core compiled as a static library.
## Release Notes
Binaries for the C++ binding file (which includes libbitcoind statically linked in) are distributed with the help of node-pre-gyp. Node-pre-gyp publishes pre-built binaries to S3 for later download and installation. Source files can also be built if binaries are not desired.
## How to release
Ensure you've followed the instructions in the README.md for building the project from source. You will be using the node-pre-gyp to package and publish the project to S3. You will also need credentials for Bitpay's bitcore-node S3 bucket and be listed as an author for the bitcore-node's npm module.
- Create a file, ".node_pre_gyprc" in your home directory
- The format of this file should be:
```json
{
"accessKeyId": "xxx",
"secretAccessKey": "yyy"
}
```
- then run the commands to push binaries corresponding to the version in package.json to S3 and npm
```bash
npm install
node-pre-gyp package publish
npm publish
```