bitcoinjs-lib/README.md
xnova 786198f130 * Fixes address.js to be able to deal with testnet P2SH addresses
* Enhanced address.js testsuite...now also verifies address versions
* Enhances README to show how to run test suite
2014-03-05 16:53:29 -05:00

54 lines
1.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# bitcoinjs-lib
Bitcoin library for node.js and browsers.
[![browser support](https://ci.testling.com/bitcoinjs/bitcoinjs-lib.png)](https://ci.testling.com/bitcoinjs/bitcoinjs-lib)
# Features
- [HD Wallets](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
- Transaction creation and signing
- ECDSA signing and verification
# Installation
`npm install bitcoinjs-lib`
## Building (for browsers)
`npm run-script compile`
## Run the test suite
First install `mocha` (e.g. `npm install -g mocha` ).
Then, just run `mocha` at the root of the `bitcoinjs-lib` checkout directory.
# Usage
## node.js
`var Bitcoin = require('bitcoinjs-lib')`
## Browser
Use the global `Bitcoin` object.
# License
This library is free and open-source software released under the MIT
license.
# Copyright
BitcoinJS (c) 2011-2012 Stefan Thomas
Released under MIT license
http://bitcoinjs.org/
JSBN (c) 2003-2005 Tom Wu
Released under BSD license
http://www-cs-students.stanford.edu/~tjw/jsbn/
CryptoJS (c) 20092012 by Jeff Mott
Released under New BSD license
http://code.google.com/p/crypto-js/