[bisq-network/bisq-docs] Produce the simplest-possible getting started guide for the Bisq HTTP API (#54)

Steve Jain notifications at github.com
Sat Jun 30 14:27:02 UTC 2018


m52go commented on this pull request.



> +
+You'll build a NodeJS-based script that connects to Bisq over an HTTP API to get offers and market prices and then displays "interesting" offers on the console if any are found.
+
+CAUTION: The Bisq HTTP API is currently incubating. Things may be rough around the edges and should not be considered production-ready. Your feedback is extremely valuable at this stage—see the link:#next-steps[next steps] section at bottom for details how to get in touch with us. Thanks!
+
+
+== What you’ll need
+
+* About 15 minutes
+* A favorite text editor or IDE
+* NodeJS 6+ (to execute the API client script that you will write)
+* Either:
+** Docker (to run from an image) or
+** Git, Maven and JDK8 (to build from source)
+
+NOTE: Using the Bisq HTTP API in no way requires the use of NodeJS on the client side. It is just used for example purposes in this guide.

I suggest removing the parenthetical note above ("to execute the API client script...") and making this note more detailed.

Specifically, explicitly state:

- Node.js is not a dependency of the HTTP API, and 
- It's only used in this guide to make the tasks of making HTTP requests and manipulating responses easier for the purposes of this example, but that those tasks can be done with any tools the user prefers.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/bisq-docs/pull/54#pullrequestreview-133427394
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20180630/9a2d9ba2/attachment.html>


More information about the bisq-github mailing list