diff --git a/src/public/index.html b/src/public/index.html index 28ed44e..be807b4 100644 --- a/src/public/index.html +++ b/src/public/index.html @@ -1,35 +1,172 @@ - + -
- + + -- This web server is based on rest.bitcoin.com. - Go there to view an interactive UI of the REST API endpoints. -
-+ bch-api is a + REST API, allowing modern applications to interact with the Bitcoin Cash (BCH) + blockchain. New to the BCH blockchain? Start by reading more about + building full stack applications on BCH. +
++ A REST API can work with any programming language, but bch-api is intended + to be paired with the + npm bch-js + JavaScript library. + Here is example code + for common BCH use cases. + + slp-cli-wallet + is another npm library that provides common wallet functionality, to get + your apps up and running as quickly as possible. +
++ While you'll be able to run through the examples without one, you should + sign-up for a free API key + in order to unlock higher rate limits. +
- - ++ This web server is based on + rest.bitcoin.com. Most endpoints + are common between the two projects. You may want to plan with their + interactive UI to explore the API endpoints. +
+