LBRYCommunity/bitcoinjs-lib
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #34 from justcoin/readme

Browse source 
Rewrite README
This commit is contained in:
Wei Lu 2014-03-02 01:21:04 +08:00
commit a253046c1b
1 changed files with 26 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -1,25 +1,31 @@
# bitcoinjs-lib # bitcoinjs-lib
A library containing Bitcoin client-side functionality in JavaScript, Bitcoin library for node.js and browsers.
most notably ECDSA signing and verification.
[Website](http://bitcoinjs.org/) • [Mailing List](https://groups.google.com/group/bitcoinjs) • [Twitter](https://twitter.com/bitcoinjs)
# Status # Features
This is currently pretty raw code. We're planning to clean it up, - [HD Wallets](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
convert everything into CommonJS modules and put a flexible build - Transaction creation and signing
system in place. - ECDSA signing and verification
Prototype software, use at your own peril. # Installation
# How to use `npm install bitcoinjs-lib`
* Run `npm run-script compile` to compile to a browser-friendly minified ## Building (for browsers)
file. Once in the browser, the global Bitcoin object will contain everything
you need. `npm run-script compile`
* To use in NodeJS, install this package as you would any other and
put in `var Bitcoin = require('bitcoinjs-lib')`. # Usage
## node.js
`var Bitcoin = require('bitcoinjs-lib')`
## Browser
Use the global `Bitcoin` object.
# License # License
@ -28,14 +34,14 @@ license.
# Copyright # Copyright
BitcoinJS (c) 2011-2012 Stefan Thomas BitcoinJS (c) 2011-2012 Stefan Thomas
Released under MIT license Released under MIT license
http://bitcoinjs.org/ http://bitcoinjs.org/
JSBN (c) 2003-2005 Tom Wu JSBN (c) 2003-2005 Tom Wu
Released under BSD license Released under BSD license
http://www-cs-students.stanford.edu/~tjw/jsbn/ http://www-cs-students.stanford.edu/~tjw/jsbn/
CryptoJS (c) 2009–2012 by Jeff Mott CryptoJS (c) 2009–2012 by Jeff Mott
Released under New BSD license Released under New BSD license
http://code.google.com/p/crypto-js/ http://code.google.com/p/crypto-js/