diff options
Diffstat (limited to 'packages/types/README.md')
-rw-r--r-- | packages/types/README.md | 45 |
1 files changed, 41 insertions, 4 deletions
diff --git a/packages/types/README.md b/packages/types/README.md index d4d48b1fe..d63970150 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -1,10 +1,47 @@ -0x types ------- +## @0xproject/types -TS types shared across 0x projects and packages +Typescript types shared across 0x projects and packages -## Install +## Installation ```bash yarn add -D @0xproject/types ``` + +## Usage + +```javascript +import { TransactionReceipt, TxData, TxDataPayable } from '@0xproject/types'; +``` + +## Contributing + +We strongly recommend that the community help us make improvements and determine the future direction of the protocol. 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 e`nabled (Yarn < v1.0) - enable them: + +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies + +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` |