@0x/instant
Installation
yarn add @0x/instant
Import
CommonJS module
import { ZeroExInstant } from '@0x/instant';
or
var ZeroExInstant = require('@0x/instant').ZeroExInstant;
If your project is in TypeScript, add the following to your tsconfig.json:
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
UMD Module
The package is also available as a UMD module named zeroExInstant.
<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.
Please read our contribution guidelines before getting started.
Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
yarn config set workspaces-experimental true
Then install dependencies
yarn install
Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0x/instant yarn build
Or continuously rebuild on change:
PKG=@0x/instant yarn watch
Clean
yarn clean
Lint
yarn lint
Run Tests
yarn test