From bff4e452b21bc088b456c63c0782a0ba5c6616f1 Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Fri, 23 Oct 2015 11:25:27 -0400 Subject: [PATCH] Update readme --- README.md | 10 +++++++--- docs/index.md | 4 +++- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a8c3222..3a51776 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,22 @@ -bitcore explorers -# Blockchain APIs for bitcore +# Bitcore Explorers [![NPM Package](https://img.shields.io/npm/v/bitcore-explorers.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-explorers) [![Build Status](https://img.shields.io/travis/bitpay/bitcore-explorers.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-explorers) [![Coverage Status](https://img.shields.io/coveralls/bitpay/bitcore-explorers.svg?style=flat-square)](https://coveralls.io/r/bitpay/bitcore-explorers) -A module for [bitcore](https://github.com/bitpay/bitcore) that implements HTTP requests to different Web APIs to query the state of the blockchain. +This module is primarily for client-side applications interacting with the Insight API. It is a module for [bitcore](https://github.com/bitpay/bitcore) that implements HTTP requests to query the state of the blockchain. ## Getting started Be careful! When using this module, the information retrieved from remote servers may be compromised and not reflect the actual state of the blockchain. ```sh +npm install bitcore-lib npm install bitcore-explorers +``` + +```sh +bower install bitcore-lib bower install bitcore-explorers ``` diff --git a/docs/index.md b/docs/index.md index f37adf7..74dfbfc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,18 +7,20 @@ Explorers is implemented as a separate module. For node projects: ``` +npm install bitcore-lib --save npm install bitcore-explorers --save ``` For client-side projects: ``` +bower install bitcore-lib --save bower install bitcore-explorers --save ``` ## Insight ### Description -`Insight` is a simple agent to perform queries to an Insight blockchain explorer. The default servers are `https://insight.bitpay.com` and `https://test-insight.bitpay.com`, hosted by BitPay Inc. You can (and we strongly suggest you do) run your own insight server. For more information, head to [https://github.com/bitpay/insight-api](https://github.com/bitpay/insight-api) +`Insight` is a simple agent to perform queries to an Insight blockchain explorer. The default servers are `https://insight.bitpay.com` and `https://test-insight.bitpay.com`, hosted by BitPay Inc. You can (and we strongly suggest you do) run your own Insight server with Bitcore. For more information, head to [https://github.com/bitpay/bitcore](https://github.com/bitpay/bitcore) and [https://github.com/bitpay/insight-api](https://github.com/bitpay/insight-api). There are currently two methods implemented: `getUnspentUtxos` and `broadcast`. The API will grow as features are requested.