From 96659894405968b856192ff1a0aaba90d7bc6f34 Mon Sep 17 00:00:00 2001 From: Manuel Araoz Date: Mon, 22 Dec 2014 17:42:45 -0300 Subject: [PATCH 1/5] update header and security warning --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b74bfb1e2..e2c7462df 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Bitcore [![Build Status](https://img.shields.io/travis/bitpay/bitcore.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore) [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore) -A pure and simple JavaScript bitcoin API. +A pure and powerful JavaScript Bitcoin API. ## Principles @@ -36,9 +36,9 @@ The complete docs are hosted here: [bitcore documentation](https://bitpay.github ## Security -Please use at your own risk. +We're using Bitcore in production, as are [many others](http://bitcore.io#projects), but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions. -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. +If you find a security issue, please email security@bitpay.com. ## Contributing From 418b4c584b7a49ec23034b646859ff4e2e4901ca Mon Sep 17 00:00:00 2001 From: Manuel Araoz Date: Mon, 22 Dec 2014 17:47:21 -0300 Subject: [PATCH 2/5] add bitpaylabs reference --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e2c7462df..0c35f7cf8 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ The complete docs are hosted here: [bitcore documentation](https://bitpay.github [![Read the Developer Guide](http://bitpay.github.io/bitcore/images/read-the-developer-guide-btn.png)](https://bitpay.github.io/bitcore/docs/#!index.md) [![Read the API Reference](http://bitpay.github.io/bitcore/images/read-the-api-reference-btn.png)](https://bitpay.github.io/bitcore/apiref) +To get community assistance and ask for help with implementation questions, please use our [community forums](http://bitpaylabs.com/c/bitcore). + ## Security We're using Bitcore in production, as are [many others](http://bitcore.io#projects), but please use common sense when doing anything related to finances! We take no responsibility for your implementation decisions. From 48e3c1676b398fb98113881455372dede12fde0e Mon Sep 17 00:00:00 2001 From: Manuel Araoz Date: Mon, 22 Dec 2014 17:54:20 -0300 Subject: [PATCH 3/5] fix docs references --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0c35f7cf8..a9d1bfe7d 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ simpleTx.sign(privateKey); ## Documentation -The complete docs are hosted here: [bitcore documentation](https://bitpay.github.io/bitcore/docs/#!index.md). There's also a [bitcore API reference](https://bitpay.github.io/bitcore/apiref) available generated from the JSDocs of the project, but we're still working on the quality and design of this API reference. +The complete docs are hosted here: [bitcore documentation](http://bitcore.io/guide/). There's also a [bitcore API reference](http://bitcore.io/api/) available generated from the JSDocs of the project, where you'll find low-level details on each bitcore utility. -[![Read the Developer Guide](http://bitpay.github.io/bitcore/images/read-the-developer-guide-btn.png)](https://bitpay.github.io/bitcore/docs/#!index.md) [![Read the API Reference](http://bitpay.github.io/bitcore/images/read-the-api-reference-btn.png)](https://bitpay.github.io/bitcore/apiref) +[![Read the Developer Guide](http://bitpay.github.io/bitcore/images/read-the-developer-guide-btn.png)](http://bitcore.io/guide/) [![Read the API Reference](http://bitpay.github.io/bitcore/images/read-the-api-reference-btn.png)](http://bitcore.io/api/) To get community assistance and ask for help with implementation questions, please use our [community forums](http://bitpaylabs.com/c/bitcore). From 11f51d873435d857ab36bee4c24a9af0de62f582 Mon Sep 17 00:00:00 2001 From: Manuel Araoz Date: Mon, 22 Dec 2014 18:03:15 -0300 Subject: [PATCH 4/5] polish README --- .jsdoc.conf | 2 +- LICENSE | 2 +- README.md | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.jsdoc.conf b/.jsdoc.conf index b0c6449b5..a6a59aa40 100644 --- a/.jsdoc.conf +++ b/.jsdoc.conf @@ -24,7 +24,7 @@ }, "templates": { "systemName": "bitcore", - "copyright": "© 2013-2014, BitPay Inc.", + "copyright": "© 2013-2015, BitPay Inc.", "navType": "vertical", "theme": "journal", "linenums": true, diff --git a/LICENSE b/LICENSE index ee1f72075..9aabde75a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013-2014 BitPay, Inc. +Copyright (c) 2013-2015 BitPay, Inc. Parts of this software are based on fullnode Copyright (c) 2014 Ryan X. Charles diff --git a/README.md b/README.md index a9d1bfe7d..6a2a1a335 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ If you find a security issue, please email security@bitpay.com. ## Contributing -Please send pull requests for bug fixes, code optimization, and ideas for improvement. +Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our [CONTRIBUTING](https://github.com/bitpay/bitcore/blob/master/CONTRIBUTING.md) file. ## Building the Browser Bundle @@ -64,19 +64,19 @@ Run all the tests: gulp test ``` -Run the tests with mocha: +Run the NodeJS tests with mocha: ```sh gulp test:node ``` -Run the tests with karma (uses firefox and chrome): +Run the browser tests with karma: ```sh gulp test:browser ``` -Create a coverage report (you can open `coverage/lcov-report/index.html` to visualize it): +Create a test coverage report (you can open `coverage/lcov-report/index.html` to visualize it): ```sh gulp coverage @@ -86,4 +86,4 @@ gulp coverage 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. +Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc. From 7d607c5fe0f578d3f99c6bd089ca7c32c45d3092 Mon Sep 17 00:00:00 2001 From: Manuel Araoz Date: Mon, 22 Dec 2014 18:27:39 -0300 Subject: [PATCH 5/5] improve example --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6a2a1a335..cf45d7d6f 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Using it in Node.js: ```javascript var bitcore = require('bitcore'); -assert(bitcore.Address.isValid(address)); +assert(bitcore.Address.isValid('126vMmY1fyznpZiFTTnty3cm1Rw8wuheev')); var simpleTx = new bitcore.Transaction(); var simpleTx.from(unspent).to(address, amount); simpleTx.sign(privateKey);