polish README
This commit is contained in:
parent
48e3c1676b
commit
11f51d8734
|
@ -24,7 +24,7 @@
|
||||||
},
|
},
|
||||||
"templates": {
|
"templates": {
|
||||||
"systemName": "bitcore",
|
"systemName": "bitcore",
|
||||||
"copyright": "© 2013-2014, BitPay Inc.",
|
"copyright": "© 2013-2015, BitPay Inc.",
|
||||||
"navType": "vertical",
|
"navType": "vertical",
|
||||||
"theme": "journal",
|
"theme": "journal",
|
||||||
"linenums": true,
|
"linenums": true,
|
||||||
|
|
2
LICENSE
2
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
|
Parts of this software are based on fullnode
|
||||||
Copyright (c) 2014 Ryan X. Charles
|
Copyright (c) 2014 Ryan X. Charles
|
||||||
|
|
10
README.md
10
README.md
|
@ -44,7 +44,7 @@ If you find a security issue, please email security@bitpay.com.
|
||||||
|
|
||||||
## Contributing
|
## 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
|
## Building the Browser Bundle
|
||||||
|
|
||||||
|
@ -64,19 +64,19 @@ Run all the tests:
|
||||||
gulp test
|
gulp test
|
||||||
```
|
```
|
||||||
|
|
||||||
Run the tests with mocha:
|
Run the NodeJS tests with mocha:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
gulp test:node
|
gulp test:node
|
||||||
```
|
```
|
||||||
|
|
||||||
Run the tests with karma (uses firefox and chrome):
|
Run the browser tests with karma:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
gulp test:browser
|
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
|
```sh
|
||||||
gulp coverage
|
gulp coverage
|
||||||
|
@ -86,4 +86,4 @@ gulp coverage
|
||||||
|
|
||||||
Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/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.
|
Copyright 2013-2015 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.
|
||||||
|
|
Loading…
Reference in New Issue