Skip to content

Latest commit

 

History

History
66 lines (50 loc) · 1.85 KB

browser.md

File metadata and controls

66 lines (50 loc) · 1.85 KB

Browser Builds

WalletCredentialsLib and most official submodules work in the browser, thanks to browserify (some modules are not fully compatible with web browsers).

The easiest and recommended way to use them, is via Bower, a browser package manager, and get the release bundles. For example, when building an app that uses wallet-credentials-lib and btc-lib, you do:

bower install wallet-credentials-lib
bower install btc-lib

You can also use a bower.json file to store the dependencies of your project:

{
  "name": "Your app name",
  "version": "0.0.1",
  "license": "MIT",
  "dependencies": {
    "@owstack/wallet-credentials-lib": "^0.0.1",
    "@owstack/btc-lib": "^0.13.7",
  }
}

and run bower install to install the dependencies.

After this, you can include the bundled release versions in your HTML file:

<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="utf-8">
  <script src="bower_components/wallet-credentials-lib/key.min.js"></script>
  <script src="bower_components/btc-lib/btc.min.js"></script>
</head>

<body>

  <script type="text/javascript">
    var walletCredentialsLib = require('@owstack/wallet-credentials-lib');
    var btcLib = require('@owstack/btc-lib');
    // etc...
  </script>

</body>

</html>

Building Custom Bundles

If you want to use a specific version of a module, instead of a release version (not recommended), you must run browserify yourself. You can get a minified browser bundle by running the following on the project root folder.

browserify --require ./index.js:wallet-credentials-lib | uglifyjs > wallet-credentials-lib.min.js
browserify --require ./index.js:btc-lib --external btc-lib | uglifyjs > btc-lib.min.js

In many of the modules you can also run the command to build a browser bundle:

gulp browser