Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BitIndex committed Apr 25, 2019
1 parent b72547f commit 1fe1c1e
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 1,081 deletions.
22 changes: 18 additions & 4 deletions README.md
@@ -1,20 +1,34 @@
# bitindex-sdk
> BitIndex Javascript SDK
# BitIndex Javascript SDK
https://www.bitindex.network

[BitIndex](https://www.bitindex.network) is a Bitcoin SV blockchain API for developers.
BitIndex is a powerful Bitcoin SV blockchain API built for developers.

Easily query transactions, addresses, blocks, xpubs and more with a powerful and simple REST API.
![bitindex_header](bitindex_header.png)

[View HTML API Documentation](https://www.bitindex.network/developers/api-documentation-v3.html)

---
## Quick Preview

Easily query balances, utxos, and transactions.

https://api.bitindex.network/api/v3/main/addr/15ES6BBymPDMYqKHEak2rpwyRHazFaBi67
https://api.bitindex.network/api/v3/main/addr/15ES6BBymPDMYqKHEak2rpwyRHazFaBi67/utxo
https://api.bitindex.network/api/v3/main/tx/96b3dc5941ce97046d4af6e7a69f4b38c48f05ef071c2a33f88807b89ab51da6

---
## Table of Contents
* [Installation and Usage](#installation-and-usage)
* [Prerequisites](#Prerequisites)
* [What's Included in this SDK](#whats-Included-in-this-SDK)
* [Endpoints](#endpoints)
* [Promises vs. Callbacks](#promises-vs-callback)
* [Browser Examples](https://github.com/BitIndex/bitindex-sdk/tree/master/lib/examples)
* [Distribution](https://github.com/BitIndex/bitindex-sdk/tree/master/dist)
- [Latest Bundle](https://github.com/BitIndex/bitindex-sdk/blob/master/dist/bundle.min.js)
- [Basic Browser Example](https://github.com/BitIndex/bitindex-sdk/blob/master/dist/basic.html)
- [Live Browser Example](https://media.bitcoinfiles.org/94dc4e05dc1a1cd87d62e3b1d69b7f0dd15dd7555948849b9ce7e81a9f690993)
- [Typescript Definitions](https://github.com/BitIndex/bitindex-sdk/blob/master/dist)
* Operations
- [Address](#address)
- [address.getUtxos](#addressgetUtxos)
Expand Down
Binary file added bitindex_header.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 0 additions & 72 deletions lib/core-client.txt

This file was deleted.

0 comments on commit 1fe1c1e

Please sign in to comment.