Updating README

This commit is contained in:
Chris Troutner
2019-05-21 08:11:14 -07:00
parent 5c81669478
commit 5fdd07b043
+33 -1
View File
@@ -1,4 +1,36 @@
[![Coverage Status](https://coveralls.io/repos/github/Bitcoin-com/rest.bitcoin.com/badge.svg?branch=ct-coveralls)](https://coveralls.io/github/Bitcoin-com/rest.bitcoin.com?branch=ct-coveralls)
# BCH API
This is a fork and alternative implementation of
the [rest.bitcoin.com](https://github.com/Bitcoin-com/rest.bitcoin.com) repository.
This repository is intended to be used for my own personal use, but it's licensed
under the MIT license like the original rest repo was, so people are free to use
it and modify it as they see fit.
This repository is intended to be paired with my alternative implementation
of [BITBOX SDK](https://github.com/Bitcoin-com/bitbox-sdk):
[BITBOX JS](https://github.com/christroutner/bitbox-js).
Here is a YouTube video explaining the use of BITBOX and this REST API:
https://www.youtube.com/watch?v=o0FfW5rZPFs
Since this repo is being worked on by one person, as a hobby, updates will be
slow. But the road map I have planned is as follows:
- Remove TypeScript and any other compiled languages, converting the repository
to standard ES8 JavaScript.
- Replace the need for Insight API with Blockbook API.
- Audit all npm dependencies and try to fix/remove any vulnerabilities.
- Setup automated dependency management through Greenkeeper, and automated
continuous-release with semantic versioning through Semantic Release.
- Ensure all unit and integration tests are passing.
- Update SLP token endpoints. Not totally sure of the scope here.
----
## REST