diff options
| author | fragosti <francesco.agosti93@gmail.com> | 2018-10-03 07:17:44 +0800 |
|---|---|---|
| committer | fragosti <francesco.agosti93@gmail.com> | 2018-10-03 07:17:44 +0800 |
| commit | 3cd7253f7b01b868b3eff012e4be434b69e62f0e (patch) | |
| tree | 92f0c93025fae260c085fc91c3b24c51f1d470f8 /packages/instant/README.md | |
| parent | ad56c9ea785a1146ce9b8715446d6cbbc1f6246b (diff) | |
| download | dexon-sol-tools-3cd7253f7b01b868b3eff012e4be434b69e62f0e.tar dexon-sol-tools-3cd7253f7b01b868b3eff012e4be434b69e62f0e.tar.gz dexon-sol-tools-3cd7253f7b01b868b3eff012e4be434b69e62f0e.tar.bz2 dexon-sol-tools-3cd7253f7b01b868b3eff012e4be434b69e62f0e.tar.lz dexon-sol-tools-3cd7253f7b01b868b3eff012e4be434b69e62f0e.tar.xz dexon-sol-tools-3cd7253f7b01b868b3eff012e4be434b69e62f0e.tar.zst dexon-sol-tools-3cd7253f7b01b868b3eff012e4be434b69e62f0e.zip | |
Add to README
Diffstat (limited to 'packages/instant/README.md')
| -rw-r--r-- | packages/instant/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/packages/instant/README.md b/packages/instant/README.md index ec114bd93..25aca9d3b 100644 --- a/packages/instant/README.md +++ b/packages/instant/README.md @@ -8,6 +8,8 @@ yarn add @0xproject/instant **Import** +**CommonJS module** + ```typescript import { ZeroExInstant } from '@0xproject/instant'; ``` @@ -26,6 +28,24 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol } ``` +**UMD Module** + +The package is also available as a UMD module named `zeroExInstant`. + +```html +<head> + <script type="text/javascript" src="[zeroExInstantUMDPath]" charset="utf-8"></script> +</head> +<body> + <div id="zeroExInstantContainer"></div> + <script> + zeroExInstant.render({ + // Initialization options + }, '#zeroExInstantContainer'); + </script> +</body> +``` + ## Contributing We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository. |