bitcore/README.md

42 lines
1.5 KiB
Markdown
Raw Normal View History

2014-01-22 14:12:45 -08:00
Bitcore
2013-07-04 13:02:18 -07:00
=======
2013-07-04 12:55:19 -07:00
2014-01-22 14:12:45 -08:00
A pure, powerful core for your bitcoin project.
2014-01-22 14:12:45 -08:00
Bitcore is a complete, native interface to the Bitcoin network, and provides the core functionality needed to develop apps for bitcoin.
2014-01-22 14:12:45 -08:00
#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.
2014-01-22 14:12:45 -08:00
**Bitcore unchains developers from fallible, centralized APIs, and provides the tools to interact with the real Bitcoin network.**
2014-01-22 14:12:45 -08:00
#Get Started
2014-01-22 14:12:45 -08:00
Bitcore runs on [node](http://nodejs.org/), and can be installed via [npm](https://npmjs.org/):
```
npm install bitcore
```
2014-01-22 14:12:45 -08:00
Let's try validating a Bitcoin address:
```
var Address = require('bitcore/Address.js').class();
2014-01-22 14:12:45 -08:00
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.