Skip to content

Commit 90bb706

Browse files
author
Braydon Fuller
committedOct 20, 2015
Include notice about Node.js v0.12, and other various README updates.
1 parent c793fee commit 90bb706

File tree

3 files changed

+10
-61
lines changed

3 files changed

+10
-61
lines changed
 

‎README.md

+6-48
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,28 @@ Bitcore
33

44
[![NPM Package](https://img.shields.io/npm/v/bitcore.svg?style=flat-square)](https://www.npmjs.org/package/bitcore)
55
[![Build Status](https://img.shields.io/travis/bitpay/bitcore.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore)
6-
[![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore)
76

87
Infrastructure to build Bitcoin and blockchain-based applications for the next generation of financial technology.
98

9+
**Note:** If you're looking for the Bitcore Library please see: https://github.com/bitpay/bitcore-lib
10+
1011
## Getting Started
1112

12-
Install with Node.js
13+
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/).
1314

1415
```bash
1516
npm install -g bitcore
1617
```
1718

18-
Install for web browsers:
19-
20-
```bash
21-
bower install bitcore
22-
```
23-
2419
Spin up a full node and join the network:
2520

2621
```bash
2722
npm install -g bitcore
28-
bitcore create mynode
29-
cd mynode
30-
bitcore start
23+
bitcored
3124
```
3225

26+
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`.
27+
3328
Create a transaction:
3429
```js
3530
var bitcore = require('bitcore');
@@ -68,18 +63,6 @@ The complete docs are hosted here: [bitcore documentation](http://bitcore.io/gui
6863

6964
To get community assistance and ask for help with implementation questions, please use our [community forums](http://bitpaylabs.com/c/bitcore).
7065

71-
## Examples
72-
73-
* [Generate a random address](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#generate-a-random-address)
74-
* [Generate a address from a SHA256 hash](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#generate-a-address-from-a-sha256-hash)
75-
* [Import an address via WIF](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#import-an-address-via-wif)
76-
* [Create a Transaction](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#create-a-transaction)
77-
* [Sign a Bitcoin message](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#sign-a-bitcoin-message)
78-
* [Verify a Bitcoin message](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#verify-a-bitcoin-message)
79-
* [Create an OP RETURN transaction](https://github.com/bitpay/bitcore/blob/master/docs/examples.md#create-an-op-return-transaction)
80-
* [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)
81-
* [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)
82-
8366
## Security
8467

8568
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.
9073

9174
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.
9275

93-
## Building the Browser Bundle
94-
95-
To build bitcore full bundle for the browser:
96-
97-
```sh
98-
gulp browser
99-
```
100-
10176
This will generate files named `bitcore.js` and `bitcore.min.js`.
10277

10378
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:
10681
- @braydonf: https://pgp.mit.edu/pks/lookup?op=get&search=0x9BBF07CAC07A276D
10782
- @pnagurny: https://pgp.mit.edu/pks/lookup?op=get&search=0x0909B33F0AA53013
10883

109-
## Development & Tests
110-
111-
```sh
112-
git clone https://github.com/bitpay/bitcore
113-
cd bitcore
114-
npm install
115-
```
116-
117-
Run all the tests:
118-
119-
```sh
120-
gulp test
121-
```
122-
123-
You can also run just the Node.js tests with `gulp test:node`, just the browser tests with `gulp test:browser`
124-
or create a test coverage report (you can open `coverage/lcov-report/index.html` to visualize it) with `gulp coverage`.
125-
12684
## License
12785

12886
Code released under [the MIT license](https://github.com/bitpay/bitcore/blob/master/LICENSE).

‎package.json

+4-11
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,7 @@
55
"author": "BitPay <dev@bitpay.com>",
66
"main": "index.js",
77
"scripts": {
8-
"lint": "gulp lint",
9-
"test": "gulp test",
10-
"coverage": "gulp coverage",
11-
"build": "gulp"
8+
"test": "./node_modules/.bin/mocha test/** --recursive"
129
},
1310
"bin": {
1411
"bitcore": "./bin/bitcore",
@@ -89,12 +86,8 @@
8986
"insight-api": "^0.3.0",
9087
"insight-ui": "^0.3.0"
9188
},
89+
"license": "MIT",
9290
"devDependencies": {
93-
"bitcore-build": "bitpay/bitcore-build#36e15f",
94-
"brfs": "^1.2.0",
95-
"chai": "^1.10.0",
96-
"gulp": "^3.8.10",
97-
"sinon": "^1.13.0"
98-
},
99-
"license": "MIT"
91+
"mocha": "^2.3.3"
92+
}
10093
}

‎test/mocha.opts

-2
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.