Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
snogcel committed Jan 9, 2017
1 parent eed15c6 commit 015c9fd
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
Bitcore Node Dash
============

A Dash full node for building applications and services with Node.js. A node is extensible and can be configured to run additional services. At the minimum a node has an interface to [Dash Core with additional indexing](https://github.com/snogcel/dash/tree/v0.12.1.x) for more advanced address queries. Additional services can be enabled to make a node more useful such as exposing new APIs, running a block explorer and wallet service.
A Dash full node for building applications and services with Node.js. A node is extensible and can be configured to run additional services. At the minimum a node has an interface to [Dash Core v0.12.1.x](https://github.com/dashpay/dash/tree/v0.12.1.x) for more advanced address queries. Additional services can be enabled to make a node more useful such as exposing new APIs, running a block explorer and wallet service.

## Install

```bash
npm install -g bitcore-node-dash
```

Installation of bitcore-node-dash can also be performed using a Dockerfile. Please note that this Dockerfile is still under development and should be considered an 'Alpha' version, see [docker-bitcore_insight_dash](https://github.com/moocowmoo/docker-bitcore_insight_dash) for more details.

## Prerequisites

- Dash Core (v0.12.1.x) with support for additional indexing *(see above)*
Expand All @@ -33,17 +31,17 @@ bitcore-node-dash start

This will create a directory with configuration files for your node and install the necessary dependencies.

Please note that [Dash Core with additional indexing](https://github.com/snogcel/dash/tree/v0.12.1.x) must be compiled seperately. Once completed the dashd binary should be placed into the <dash-data-dir> folder specified during node creation.
Please note that [Dash Core v0.12.1.x](https://github.com/dashpay/dash/tree/v0.12.1.x) will be downloaded automatically. Once completed the dashd binary should be placed into the <dash-data-dir> folder specified during node creation.

For more information about (and developing) services, please see the [Service Documentation](docs/services.md).

## Add-on Services

There are several add-on services available to extend the functionality of Bitcore:

- [Insight API Dash](https://github.com/dashpay/insight-api-dash/tree/master)
- [Insight UI Dash](https://github.com/dashpay/insight-ui-dash/tree/master)
- Bitcore Wallet Service (coming soon)
- [Insight API](https://github.com/dashpay/insight-api-dash/tree/master)
- [Insight UI](https://github.com/dashpay/insight-ui-dash/tree/master)
- [Bitcore Wallet Service](https://github.com/dashpay/bitcore-wallet-service/tree/master)

## Documentation

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@
"coveralls": "./node_modules/.bin/istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- --recursive -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js"
},
"tags": [
"bitcoin",
"bitcoind"
"dash",
"dashd"
],
"dependencies": {
"async": "^1.3.0",
Expand Down

0 comments on commit 015c9fd

Please sign in to comment.