update readme

This commit is contained in:
Jason Dreyzehner 2014-01-22 17:12:45 -05:00
parent 8221293922
commit cb2a86def1
1 changed files with 31 additions and 18 deletions

View File

@ -1,28 +1,41 @@
bitcore
Bitcore
=======
Nodejs Bitcoin Library
A pure, powerful core for your bitcoin project.
Bitcore is a complete, native interface to the Bitcoin network, and provides the core functionality needed to develop apps for bitcoin.
#Principles
Bitcoin is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Bitcoin network allows for highly resilient bitcoin infrastructure, but the developer community needs reliable, open-source tools to implement bitcoin apps and services.
INSTALLATION
============
**Bitcore unchains developers from fallible, centralized APIs, and provides the tools to interact with the real Bitcoin network.**
For Ubuntu:
#Get Started
# install git
sudo apt-get install git
Bitcore runs on [node](http://nodejs.org/), and can be installed via [npm](https://npmjs.org/):
```
npm install bitcore
```
# download the code
git clone https://github.com/bitpay/bitcore.git
Let's try validating a Bitcoin address:
```
var Address = require('bitcore/Address.js').class();
# obtain latest version of node.js
sudo apt-get update
sudo apt-get install -y python-software-properties python g++ make
sudo add-apt-repository -y ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs
var addr = new Address("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa");
try {
addr.validate();
console.log("address is valid");
} catch(e) {
console.log(addr.data + " is not a valid address.")
}
```
#Security
Please use at your own risk. Bitcore is still under heavy development and not quite ready for "drop-in" production use.
Bitpay offers a bounty program for security vulnerabilities found in Bitcore. If you find a security issue, please email security@bitcore.io.
#Contributing
Bitcore needs some developer love. Please send pull requests for bug fixes, code optimization, and ideas for improvement.
# install bitcore
cd bitcore/
npm install