Docs update

- Some users are confused on whether or not they can use the home directory expansion shortcut.
- Changed to absolute example path to more accurately demonstrate.
This commit is contained in:
Chris Kleeschulte 2015-12-08 15:38:16 -05:00
parent 59701c4c34
commit 838d35b294
3 changed files with 3 additions and 3 deletions

View File

@ -19,7 +19,7 @@ var Bitcoin = index.services.Bitcoin;
var Node = index.Node; var Node = index.Node;
var configuration = { var configuration = {
datadir: '~/.bitcoin', datadir: '/home/user/.bitcoin',
network: 'testnet', network: 'testnet',
services: [ services: [
{ {

View File

@ -11,7 +11,7 @@ This function will load a configuration file `bitcore-node.json` and instantiate
This function will recursively find a configuration `bitcore-node.json` file in parent directories and return the result. This function will recursively find a configuration `bitcore-node.json` file in parent directories and return the result.
## Default Config ## Default Config
This function will return a default configuration with the default services based on environment variables, and will default to using the standard `~/.bitcoin` data directory. This function will return a default configuration with the default services based on environment variables, and will default to using the standard `/home/user/.bitcoin` data directory.
## Uninstall ## Uninstall
This function will remove a service from a node by uninstalling the necessary dependencies and modifying the `bitcore-node.json` configuration. This function will remove a service from a node by uninstalling the necessary dependencies and modifying the `bitcore-node.json` configuration.

View File

@ -43,7 +43,7 @@ var DB = bitcore.services.DB;
var Web = bitcore.services.Web; var Web = bitcore.services.Web;
var myNode = new bitcore.Node({ var myNode = new bitcore.Node({
datadir: '~/.bitcore', datadir: '/home/user/.bitcore',
network: { network: {
name: 'livenet' name: 'livenet'
}, },