diff options
| author | Francesco Agosti <francesco.agosti93@gmail.com> | 2018-10-03 08:07:23 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-10-03 08:07:23 +0800 |
| commit | bce43a0050056195acb9c4890f57526985268da9 (patch) | |
| tree | e45bd26d0c602d9a1d5a820fba61d56ee67cadab /packages/instant/README.md | |
| parent | 678deccfcad5b0e9039b82b766def6b383ede786 (diff) | |
| parent | 81b08c0339ba94167d4192261cc5ed42f7614019 (diff) | |
| download | dexon-sol-tools-bce43a0050056195acb9c4890f57526985268da9.tar dexon-sol-tools-bce43a0050056195acb9c4890f57526985268da9.tar.gz dexon-sol-tools-bce43a0050056195acb9c4890f57526985268da9.tar.bz2 dexon-sol-tools-bce43a0050056195acb9c4890f57526985268da9.tar.lz dexon-sol-tools-bce43a0050056195acb9c4890f57526985268da9.tar.xz dexon-sol-tools-bce43a0050056195acb9c4890f57526985268da9.tar.zst dexon-sol-tools-bce43a0050056195acb9c4890f57526985268da9.zip | |
Merge pull request #1109 from 0xProject/feature/instant/init
[instant] Initialize the package with dev environment and tests etc..
Diffstat (limited to 'packages/instant/README.md')
| -rw-r--r-- | packages/instant/README.md | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/packages/instant/README.md b/packages/instant/README.md new file mode 100644 index 000000000..25aca9d3b --- /dev/null +++ b/packages/instant/README.md @@ -0,0 +1,99 @@ +## @0xproject/instant + +## Installation + +```bash +yarn add @0xproject/instant +``` + +**Import** + +**CommonJS module** + +```typescript +import { ZeroExInstant } from '@0xproject/instant'; +``` + +or + +```javascript +var ZeroExInstant = require('@0xproject/instant').ZeroExInstant; +``` + +If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: + +```json +"compilerOptions": { + "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], +} +``` + +**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. + +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. + +### Install dependencies + +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: + +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies + +```bash +yarn install +``` + +### Build + +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: + +```bash +PKG=@0xproject/instant yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=@0xproject/instant yarn watch +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` |