From 145a7208a0d913ff96cbfb0f8838a1e48b9185b6 Mon Sep 17 00:00:00 2001 From: Gustavo Cortez Date: Fri, 10 Jan 2014 02:14:56 -0300 Subject: [PATCH] completed readme.md for api prerequisites --- README.md | 40 ++++++++++++++++++++++++---------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index ca751e3..9127bf9 100644 --- a/README.md +++ b/README.md @@ -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 /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]