bitcoinjs-lib/README.md

42 lines
1.2 KiB
Markdown
Raw Normal View History

2011-05-06 01:08:46 +02:00
# bitcoinjs-lib
A library containing Bitcoin client-side functionality in JavaScript,
most notably ECDSA signing and verification.
2013-04-21 11:04:23 +02:00
[Website](http://bitcoinjs.org/) • [Mailing List](https://groups.google.com/group/bitcoinjs) • [Twitter](https://twitter.com/bitcoinjs)
2011-05-06 01:08:46 +02:00
# Status
This is currently pretty raw code. We're planning to clean it up,
convert everything into CommonJS modules and put a flexible build
system in place.
Prototype software, use at your own peril.
2011-12-20 12:47:50 +01:00
# How to use
* Run `npm run-script compile` to compile to a browser-friendly minified
file. Once in the browser, the global Bitcoin object will contain everything
you need.
* To use in NodeJS, install this package as you would any other and
put in `var Bitcoin = require('bitcoinjs-lib')`.
2011-12-20 12:47:50 +01:00
# License
This library is free and open-source software released under the MIT
license.
2012-07-30 19:09:21 +02:00
# Copyright
BitcoinJS (c) 2011-2012 Stefan Thomas
Released under MIT license
2012-07-30 19:09:21 +02:00
http://bitcoinjs.org/
JSBN (c) 2003-2005 Tom Wu
Released under BSD license
2012-07-30 19:09:21 +02:00
http://www-cs-students.stanford.edu/~tjw/jsbn/
CryptoJS (c) 20092012 by Jeff Mott
Released under New BSD license
2012-07-30 19:09:21 +02:00
http://code.google.com/p/crypto-js/