Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #24

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
<img src="http://bitcore.io/css/images/module-explorer.png" alt="bitcore explorers" height="35">
# 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
```

Expand Down
4 changes: 3 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down