updates to README for 1.0.0 release

This commit is contained in:
Kyle Drake 2014-07-01 12:30:14 -05:00
parent 8ffd5795db
commit 7eb0a83cf1

View file

@ -1,40 +1,39 @@
# bitcoinjs-lib # BitcoinJS (bitcoinjs-lib)
[![Build Status](https://travis-ci.org/bitcoinjs/bitcoinjs-lib.png?branch=master)](https://travis-ci.org/bitcoinjs/bitcoinjs-lib) [![Coverage Status](https://coveralls.io/repos/bitcoinjs/bitcoinjs-lib/badge.png)](https://coveralls.io/r/bitcoinjs/bitcoinjs-lib) [![Build Status](https://travis-ci.org/bitcoinjs/bitcoinjs-lib.png?branch=master)](https://travis-ci.org/bitcoinjs/bitcoinjs-lib) [![Coverage Status](https://coveralls.io/repos/bitcoinjs/bitcoinjs-lib/badge.png)](https://coveralls.io/r/bitcoinjs/bitcoinjs-lib)
[![Browser Support](https://ci.testling.com/bitcoinjs/bitcoinjs-lib.png)](https://ci.testling.com/bitcoinjs/bitcoinjs-lib) [![Browser Support](https://ci.testling.com/bitcoinjs/bitcoinjs-lib.png)](https://ci.testling.com/bitcoinjs/bitcoinjs-lib)
A pure JavaScript Bitcoin library for node.js and browsers. The pure JavaScript Bitcoin library for node.js and browsers.
A continued implementation of the original `0.1.3` version used by over a million wallet users; and the backbone for almost all Bitcoin web wallets in production today. A continued implementation of the original `0.1.3` version used by over a million wallet users; the backbone for almost all Bitcoin web wallets in production today.
## Features
- Clean: Pure JavaScript, concise code, easy to read.
- Tested: Coverage > 90%, third-party integration tests.
- Careful: Two person approval process for small, focused pull requests.
- Compatible: Works on Node.js and all modern browsers.
- Powerful: Support for advanced features, such as multi-sig, HD Wallets.
- Secure: Strong random number generation, PGP signed releases, trusted developers.
- Principled: No support for browsers with crap RNG (IE < 11)
- Standardized: Node community coding style, Browserify, Node's stdlib and Buffers.
- Fast: Optimized code, uses typed arrays instead of byte arrays for performance.
- Experiment-friendly: Bitcoin Mainnet and Testnet support.
- Altcoin-ready: Capable of working with bitcoin-derived cryptocurrencies (such as Dogecoin).
## Should I use this in production? ## Should I use this in production?
If you are thinking of using the master branch of this library in production, stop. If you are thinking of using the master branch of this library in production, stop.
Master is not stable; it is our development branch, and only tagged releases may be classified as stable. Master is not stable; it is our development branch, and only tagged releases may be classified as stable.
Master is currently being heavily refactored to clean things up, add new functionality and merge improvements from the community. If you are looking for the original, it is tagged as `0.1.3`. Unless you need it for dependency reasons, it is highly recommended that you use the newest version, which adds major functionality, fixes many bugs, and is well tested.
If you are looking for the original, it is tagged as `0.1.3`.
We are releasing quasi-stable releases tagged under `0.2.x`, with the expectation that this is still beta software and is `PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED`.
This is not the original bitcoinjs-lib that was not updated for a long time.
## Features
- Default's to the Bitcoin network, however testnet, Dogecoin and Litecoin are all supported natively.
- [HD Wallets](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki).
- Random private key generation that uses [window.crypto.getRandomValues](https://developer.mozilla.org/en-US/docs/Web/API/Window.crypto) in the underlying implementation.
- ECDSA signing and verification.
- Standard transaction creation, with support for PubKeyHash, ScriptHash, MultiSig and PubKey scripts, and
- A (somewhat incomplete) wallet implementation, with improvements ongoing.
## Installation ## Installation
`npm install bitcoinjs-lib` `npm install bitcoinjs-lib`
Note: The npm version is currently out of date, are working to resolve this. The best way to use the latest code is to clone the repository.
## Setup ## Setup
@ -103,13 +102,15 @@ console.log(tx.toHex())
## Projects utilizing bitcoinjs-lib ## Projects utilizing bitcoinjs-lib
- [Blockchain.info Wallet](http://blockchain.info/wallet) - [Blockchain.info Wallet](https://blockchain.info/wallet)
- [Bitaddress.org](https://www.bitaddress.org) - [Bitaddress.org](https://www.bitaddress.org)
- [Coinpunk](https://coinpunk.com) - [Coinpunk](https://coinpunk.com)
- [DarkWallet](https://darkwallet.unsystem.net) - [DarkWallet](https://darkwallet.unsystem.net)
- [GreenAddress](https://greenaddress.it) - [GreenAddress](https://greenaddress.it)
- [Dogechain Wallet](https://dogechain.info) - [Dogechain Wallet](https://dogechain.info)
- [Justcoin Exchange](https://justcoin.com) - [Justcoin Exchange](https://justcoin.com)
- [Brainwallet](https://brainwallet.github.io)
- [Skyhook ATM](http://projectskyhook.com)
Feel free to send pull requests to have your project/startup listed here. Feel free to send pull requests to have your project/startup listed here.
@ -126,10 +127,13 @@ Feel free to send pull requests to have your project/startup listed here.
### Running the test suite ### Running the test suite
$ npm test $ npm test
$ npm run-script coverage
## Alternatives ## Alternatives / Complementing Libraries
- [BCoin](https://github.com/indutny/bcoin)
- [Bitcore](https://github.com/bitpay/bitcore) - [Bitcore](https://github.com/bitpay/bitcore)
- [Cryptocoin](https://github.com/cryptocoinjs/cryptocoin) - [Cryptocoin](https://github.com/cryptocoinjs/cryptocoin)
@ -143,8 +147,3 @@ This library is free and open-source software released under the MIT license.
BitcoinJS (c) 2011-2012 Stefan Thomas BitcoinJS (c) 2011-2012 Stefan Thomas
Released under MIT license Released under MIT license
http://bitcoinjs.org/
CryptoJS (c) 20092012 by Jeff Mott
Released under New BSD license
http://code.google.com/p/crypto-js/