completed readme.md for api prerequisites

This commit is contained in:
Gustavo Cortez 2014-01-10 02:14:56 -03:00
parent d1a62d9c9d
commit 145a7208a0
1 changed files with 24 additions and 16 deletions

View File

@ -45,26 +45,34 @@ $ npm install -g bower
http://localhost:3000
## Prerequisites
Get bitcore from github repository:
$ git clone https://github.com/bitpay/bitcore.git
$ cd bitcore
$ npm install
Run sync from mystery repository:
$ utils/sync.js
check utils/sync.js --help for options.
## API
A REST API is provided at /api. The entry points are:
### Prerequisites
Get bitcore from github repository:
$ git clone https://github.com/bitpay/bitcore.git
$ cd bitcore
$ npm install
Then create a symbolic link from this to your mystery repository. We need to
use bitcore from github, not with npm for now:
$ cd mystery/node_modules
$ rm -R bitcore
$ ln -s <path-to-your-clone-repositoy>/bitcore
Run sync from mystery repository (to save blocks in MongoDB):
$ utils/sync.js
Check utils/sync.js --help for options.
### Blocks
```
/api/block/[:hash]