zcash-hackworks
/
bitcore-lib-zcash
mirror of https://github.com/zcash-hackworks/bitcore-lib-zcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Jason Dreyzehner 2014-01-23 11:17:43 -05:00
parent eddcce11a7
commit f29da24561
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -17,26 +17,30 @@ Bitcore runs on [node](http://nodejs.org/), and can be installed via [npm](https
npm install bitcore
```
It's 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:
```
var Address = require('bitcore/Address').class();
```
#Examples
Validating a Bitcoin address:
```
var Address = require('bitcore/Address.js').class();
var Address = require('bitcore/Address').class();
var addr = new Address("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa");
try {
addr.validate();
console.log("address is valid");
console.log("Address is valid!");
} catch(e) {
console.log(addr.data + " is not a valid address.")
console.log("Address is not valid.")
}
```
#Security
Please use at your own risk. Bitcore is still under heavy development and not quite ready for "drop-in" production use.
Please use at your own risk.
Bitpay offers a bounty program for security vulnerabilities found in Bitcore. If you find a security issue, please email security@bitcore.io.
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.
#Contributing
Bitcore needs some developer love. Please send pull requests for bug fixes, code optimization, and ideas for improvement.