From 88718db1fb79791bdb02dda6176c23476e288cc9 Mon Sep 17 00:00:00 2001 From: Paul Shapiro Date: Thu, 3 Jan 2019 18:50:30 -0600 Subject: [PATCH] updated README to discuss bin/package_browser_js, mymonero_core_js global etc --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index ffd94ce..254ae0f 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,18 @@ Library integrators may use `MyMoneroCoreBridge` by `require("./monero_utils/MyM Many related utility functions and data structures are located throughout `monero_utils/`, `cryptonote_utils`, and `hostAPI`. Usage below. +Various convenience scripts are provided in `./bin`. + This readme is located at `README.md`, and the license is located at `LICENSE.txt`. ## Usage +If you would like to package this library to run in a standalone manner within, e.g. a webpage, similarly to how the old mymonero.com used this library, a script is provided to bundle everything for you. It's located at `bin/package_browser_js`. If you package the library in this manner, the resulting `mymonero-core.js` file can be included via a script tag. The index.js of the library will then be available as the global variable `mymonero_core_js`. + +Alternatively you can bundle the contents in any other manner you prefer, including directly accessing them via your favorite module system. + + ### `hostAPI` Use the functions in the modules in `hostAPI` for convenience implementations of (a) networking to a MyMonero-API-compatible server, (b) constructing common request bodies, and (c) parsing responses.