aboutsummaryrefslogtreecommitdiffstats
path: root/packages/types/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/types/README.md')
-rw-r--r--packages/types/README.md12
1 files changed, 4 insertions, 8 deletions
diff --git a/packages/types/README.md b/packages/types/README.md
index c549a736f..d63970150 100644
--- a/packages/types/README.md
+++ b/packages/types/README.md
@@ -1,5 +1,4 @@
-@0xproject/types
-------
+## @0xproject/types
Typescript types shared across 0x projects and packages
@@ -12,14 +11,9 @@ yarn add -D @0xproject/types
## Usage
```javascript
-import {
- TransactionReceipt,
- TxData,
- TxDataPayable,
-} from '@0xproject/types';
+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.
@@ -29,11 +23,13 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting
### 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
```