diff options
author | fragosti <francesco.agosti93@gmail.com> | 2018-09-28 19:09:16 +0800 |
---|---|---|
committer | fragosti <francesco.agosti93@gmail.com> | 2018-09-28 19:09:16 +0800 |
commit | 2471e1034664c348cb9fa4646b306f48c44572ec (patch) | |
tree | deae8e9a3f911784eb611b91525b2030d114c08b /packages/instant/README.md | |
parent | a737cfa004ee1dc18be935f61fb9c289ed5623fd (diff) | |
download | dexon-0x-contracts-2471e1034664c348cb9fa4646b306f48c44572ec.tar dexon-0x-contracts-2471e1034664c348cb9fa4646b306f48c44572ec.tar.gz dexon-0x-contracts-2471e1034664c348cb9fa4646b306f48c44572ec.tar.bz2 dexon-0x-contracts-2471e1034664c348cb9fa4646b306f48c44572ec.tar.lz dexon-0x-contracts-2471e1034664c348cb9fa4646b306f48c44572ec.tar.xz dexon-0x-contracts-2471e1034664c348cb9fa4646b306f48c44572ec.tar.zst dexon-0x-contracts-2471e1034664c348cb9fa4646b306f48c44572ec.zip |
Have React setup with basic build working
Diffstat (limited to 'packages/instant/README.md')
-rw-r--r-- | packages/instant/README.md | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/packages/instant/README.md b/packages/instant/README.md new file mode 100644 index 000000000..ec114bd93 --- /dev/null +++ b/packages/instant/README.md @@ -0,0 +1,79 @@ +## @0xproject/instant + +## Installation + +```bash +yarn add @0xproject/instant +``` + +**Import** + +```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"], +} +``` + +## 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 +``` |