diff options
Diffstat (limited to 'packages/types/README.md')
-rw-r--r-- | packages/types/README.md | 51 |
1 files changed, 48 insertions, 3 deletions
diff --git a/packages/types/README.md b/packages/types/README.md index d4d48b1fe..3352128a3 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -1,10 +1,55 @@ -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 encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. + +[CONTRIBUTING.md](../../CONTRIBUTING.md) + +### Install Dependencies + +If you don't have yarn workspaces enabled - enable them: +```bash +yarn config set workspaces-experimental true +``` + +Then install dependencies +```bash +yarn install +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +N/A |