Add to README

2018-10-02 16:17:44 -07:00
parent ad56c9ea78
commit 3cd7253f7b
1 changed files with 20 additions and 0 deletions
--- 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.