Include notice about Node.js v0.12, and other various README updates.
This commit is contained in:
Braydon Fuller
parent
c793feec95
commit
90bb706693
54
README.md
54
README.md
|
|
@ -3,33 +3,28 @@ Bitcore
|
|||
|
||||
[](https://www.npmjs.org/package/bitcore)
|
||||
[](https://travis-ci.org/bitpay/bitcore)
|
||||
[](https://coveralls.io/r/bitpay/bitcore)
|
||||
|
||||
Infrastructure to build Bitcoin and blockchain-based applications for the next generation of financial technology.
|
||||
|
||||
**Note:** If you're looking for the Bitcore Library please see: https://github.com/bitpay/bitcore-lib
|
||||
|
||||
## Getting Started
|
||||
|
||||
Install with Node.js
|
||||
Before you begin you'll need to have Node.js v0.12 installed. There are several options for installation. One method is to use [nvm](https://github.com/creationix/nvm) to easily switch between different versions, or download directly from [Node.js](https://nodejs.org/).
|
||||
|
||||
```bash
|
||||
npm install -g bitcore
|
||||
```
|
||||
|
||||
Install for web browsers:
|
||||
|
||||
```bash
|
||||
bower install bitcore
|
||||
```
|
||||
|
||||
Spin up a full node and join the network:
|
||||
|
||||
```bash
|
||||
npm install -g bitcore
|
||||
bitcore create mynode
|
||||
cd mynode
|
||||
bitcore start
|
||||
bitcored
|
||||
```
|
||||
|
||||
You can then view the Insight block explorer at the default location: `http://localhost:3001/insight`, and your configuration file will be found in your home directory at `~/.bitcore`.
|
||||
|
||||
Create a transaction:
|
||||
```js
|
||||
var bitcore = require('bitcore');
|
||||
|
|
@ -68,18 +63,6 @@ The complete docs are hosted here: [bitcore documentation](http://bitcore.io/gui
|
|||
|
||||
To get community assistance and ask for help with implementation questions, please use our [community forums](http://bitpaylabs.com/c/bitcore).
|
||||
|
||||
## Examples
|
||||
|
||||
* [Generate a random address](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#generate-a-random-address)
|
||||
* [Generate a address from a SHA256 hash](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#generate-a-address-from-a-sha256-hash)
|
||||
* [Import an address via WIF](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#import-an-address-via-wif)
|
||||
* [Create a Transaction](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#create-a-transaction)
|
||||
* [Sign a Bitcoin message](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#sign-a-bitcoin-message)
|
||||
* [Verify a Bitcoin message](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#verify-a-bitcoin-message)
|
||||
* [Create an OP RETURN transaction](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#create-an-op-return-transaction)
|
||||
* [Create a 2-of-3 multisig P2SH address](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#create-a-2-of-3-multisig-p2sh-address)
|
||||
* [Spend from a 2-of-2 multisig P2SH address](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#spend-from-a-2-of-2-multisig-p2sh-address)
|
||||
|
||||
## 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.
|
||||
|
|
@ -90,14 +73,6 @@ If you find a security issue, please email security@bitpay.com.
|
|||
|
||||
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
|
||||
|
||||
To build bitcore full bundle for the browser:
|
||||
|
||||
```sh
|
||||
gulp browser
|
||||
```
|
||||
|
||||
This will generate files named `bitcore.js` and `bitcore.min.js`.
|
||||
|
||||
You can also use our pre-generated files, provided for each release along with a PGP signature by one of the project's maintainers. To get them, checkout a release commit (for example, https://github.com/bitpay/bitcore/commit/e33b6e3ba6a1e5830a079e02d949fce69ea33546 for v0.12.6).
|
||||
|
|
@ -106,23 +81,6 @@ To verify signatures, use the following PGP keys:
|
|||
- @braydonf: https://pgp.mit.edu/pks/lookup?op=get&search=0x9BBF07CAC07A276D
|
||||
- @pnagurny: https://pgp.mit.edu/pks/lookup?op=get&search=0x0909B33F0AA53013
|
||||
|
||||
## Development & Tests
|
||||
|
||||
```sh
|
||||
git clone https://github.com/bitpay/bitcore
|
||||
cd bitcore
|
||||
npm install
|
||||
```
|
||||
|
||||
Run all the tests:
|
||||
|
||||
```sh
|
||||
gulp test
|
||||
```
|
||||
|
||||
You can also run just the Node.js tests with `gulp test:node`, just the browser tests with `gulp test:browser`
|
||||
or create a test coverage report (you can open `coverage/lcov-report/index.html` to visualize it) with `gulp coverage`.
|
||||
|
||||
## License
|
||||
|
||||
Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).
|
||||
|
|
|
|||
15
package.json
15
package.json
|
|
@ -5,10 +5,7 @@
|
|||
"author": "BitPay <dev@bitpay.com>",
|
||||
"main": "index.js",
|
||||
"scripts": {
|
||||
"lint": "gulp lint",
|
||||
"test": "gulp test",
|
||||
"coverage": "gulp coverage",
|
||||
"build": "gulp"
|
||||
"test": "./node_modules/.bin/mocha test/** --recursive"
|
||||
},
|
||||
"bin": {
|
||||
"bitcore": "./bin/bitcore",
|
||||
|
|
@ -89,12 +86,8 @@
|
|||
"insight-api": "^0.3.0",
|
||||
"insight-ui": "^0.3.0"
|
||||
},
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
"bitcore-build": "bitpay/bitcore-build#36e15f",
|
||||
"brfs": "^1.2.0",
|
||||
"chai": "^1.10.0",
|
||||
"gulp": "^3.8.10",
|
||||
"sinon": "^1.13.0"
|
||||
},
|
||||
"license": "MIT"
|
||||
"mocha": "^2.3.3"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
--recursive
|
||||
--timeout 5000
|
||||
Loading…
Reference in New Issue