You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

64 lines
2.1 KiB

11 years ago
Bitcore
12 years ago
=======
12 years ago
11 years ago
A pure, powerful core for your bitcoin project.
11 years ago
Bitcore is a complete, native interface to the Bitcoin network, and provides the core functionality needed to develop apps for bitcoin.
11 years ago
#Principles
11 years ago
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, and the developer community needs reliable, open-source tools to implement bitcoin apps and services.
11 years ago
**Bitcore unchains developers from fallible, centralized APIs, and provides the tools to interact with the real Bitcoin network.**
11 years ago
#Get Started
11 years ago
Bitcore runs on [node](http://nodejs.org/), and can be installed via [npm](https://npmjs.org/):
```
npm install bitcore
```
11 years ago
It is a collection of objects useful to bitcoin applications; class-like idioms are enabled via [Classtool](https://github.com/gasteve/classtool). In most cases, a developer will require the object's class directly:
11 years ago
```
var Address = require('bitcore/Address').class();
```
11 years ago
#Examples
Validating a Bitcoin address:
11 years ago
```
11 years ago
var Address = require('bitcore/Address').class();
11 years ago
var addr = new Address("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa");
11 years ago
11 years ago
try {
addr.validate();
11 years ago
console.log("Address is valid.");
11 years ago
} catch(e) {
11 years ago
console.log(addr.data + " is not a valid address. " + e);
11 years ago
}
```
#Security
11 years ago
Please use at your own risk.
11 years ago
11 years ago
Bitcore is still under heavy development and not quite ready for "drop-in" production use. If you find a security issue, please email security@bitcore.io.
11 years ago
#Contributing
Bitcore needs some developer love. Please send pull requests for bug fixes, code optimization, and ideas for improvement.
11 years ago
Work to enable Bitcore for use in the browser is ongoing. To build bitcore for the browser:
```
npm install -g grunt-cli
grunt browserify
```
11 years ago
#License
**Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).**
Copyright 2013-2014 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/bitpay/bitcore/trend.png)](https://bitdeli.com/free "Bitdeli Badge")