bitcore-lib-zcash/docs/browser.md

# Browser Builds
Bitcore and most official submodules work in the browser, thanks to [browserify](http://browserify.org/) (some modules are not fully compatible with web browsers).

The easiest and recommended way to use them, is via [Bower](http://bower.io/), a browser package manager, and get the release bundles. For example, when building an app that uses `bitcore` and `bitcore-mnemonic`, you do:

```sh
bower install bitcore-lib
bower install bitcore-mnemonic
```

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

```json
{
  "name": "Your app name",
  "version": "0.0.1",
  "license": "MIT",
  "dependencies": {
    "bitcore-lib": "^0.13.7",
    "bitcore-mnemonic": "^1.0.1"
  }
}
```

and run `bower install` to install the dependencies.

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

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

<head>
  <meta charset="utf-8">
  <script src="bower_components/bitcore/bitcore-lib.min.js"></script>
  <script src="bower_components/bitcore-mnemonic/bitcore-mnemonic.min.js"></script>
</head>

<body>

  <script type="text/javascript">
    var bitcore = require('bitcore-lib');
    var Mnemonic = require('bitcore-mnemonic');
    // 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.

```sh
browserify --require ./index.js:bitcore-lib | uglifyjs > bitcore-lib.min.js
```

```sh
browserify --require ./index.js:bitcore-mnemonic --external bitcore-lib | uglifyjs > bitcore-mnemonic.min.js
```

In many of the modules you can also run the command to build a browser bundle:
```sh
gulp browser
```
Docs: Added documentation about building a browser bundle. 2014-12-29 08:20:22 -08:00			`# Browser Builds`
minor fixes 2015-02-24 06:26:37 -08:00			`Bitcore and most official submodules work in the browser, thanks to [browserify](http://browserify.org/) (some modules are not fully compatible with web browsers).`
document modern browser usage 2015-02-23 14:30:25 -08:00
Update browser docs. 2015-10-21 20:01:52 -07:00			The easiest and recommended way to use them, is via [Bower](http://bower.io/), a browser package manager, and get the release bundles. For example, when building an app that uses `bitcore` and `bitcore-mnemonic`, you do:
document modern browser usage 2015-02-23 14:30:25 -08:00
add sh types 2015-02-23 14:32:57 -08:00			```sh
Update browser docs. 2015-10-21 20:01:52 -07:00			`bower install bitcore-lib`
			`bower install bitcore-mnemonic`
document modern browser usage 2015-02-23 14:30:25 -08:00			```

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

			```json
			`{`
			`"name": "Your app name",`
			`"version": "0.0.1",`
			`"license": "MIT",`
			`"dependencies": {`
Update browser docs. 2015-10-21 20:01:52 -07:00			`"bitcore-lib": "^0.13.7",`
			`"bitcore-mnemonic": "^1.0.1"`
document modern browser usage 2015-02-23 14:30:25 -08:00			`}`
			`}`
			```
format docs 2015-10-16 09:43:27 -07:00
document modern browser usage 2015-02-23 14:30:25 -08:00			and run `bower install` to install the dependencies.

			`After this, you can include the bundled release versions in your HTML file:`
format docs 2015-10-16 09:43:27 -07:00
document modern browser usage 2015-02-23 14:30:25 -08:00			```html
			`<!DOCTYPE html>`
			`<html lang="en">`

			`<head>`
			`<meta charset="utf-8">`
Update browser docs. 2015-10-21 20:01:52 -07:00			`<script src="bower_components/bitcore/bitcore-lib.min.js"></script>`
			`<script src="bower_components/bitcore-mnemonic/bitcore-mnemonic.min.js"></script>`
document modern browser usage 2015-02-23 14:30:25 -08:00			`</head>`

			`<body>`

			`<script type="text/javascript">`
Update browser docs. 2015-10-21 20:01:52 -07:00			`var bitcore = require('bitcore-lib');`
			`var Mnemonic = require('bitcore-mnemonic');`
document modern browser usage 2015-02-23 14:30:25 -08:00			`// etc...`
			`</script>`

			`</body>`

			`</html>`
			```

capitalize 2015-02-24 07:59:36 -08:00			`## Building Custom Bundles`
format docs 2015-10-16 09:43:27 -07:00			`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.`
document modern browser usage 2015-02-23 14:30:25 -08:00
add sh types 2015-02-23 14:32:57 -08:00			```sh
Update browser docs. 2015-10-21 20:01:52 -07:00			`browserify --require ./index.js:bitcore-lib \| uglifyjs > bitcore-lib.min.js`
document modern browser usage 2015-02-23 14:30:25 -08:00			```
format docs 2015-10-16 09:43:27 -07:00
add sh types 2015-02-23 14:32:57 -08:00			```sh
Update browser docs. 2015-10-21 20:01:52 -07:00			`browserify --require ./index.js:bitcore-mnemonic --external bitcore-lib \| uglifyjs > bitcore-mnemonic.min.js`
document modern browser usage 2015-02-23 14:30:25 -08:00			```

Update browser docs. 2015-10-21 20:01:52 -07:00			`In many of the modules you can also run the command to build a browser bundle:`
			```sh
			`gulp browser`
Docs: Added documentation about building a browser bundle. 2014-12-29 08:20:22 -08:00			```