aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--packages/instant/README.md20
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.