crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix yarn workspaces explanation

Browse Source
This commit is contained in:
Leonid Logvinov 2017-12-20 14:17:17 +01:00
parent c3508dcdc6
commit 8ed776e113
No known key found for this signature in database
GPG Key ID: 0DD294BFDE8C95D4
4 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/assert/README.md
View File

@ -25,7 +25,7 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting
### Install Dependencies
If you don't have yarn workspaces enabled - enable them:
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```

2
packages/json-schemas/README.md
View File

@ -32,7 +32,7 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting
### Install Dependencies
If you don't have yarn workspaces enabled - enable them:
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```

3
packages/tslint-config/README.md
View File

@ -11,6 +11,7 @@ yarn add --dev @0xproject/tslint-config
## Usage
Add the following to your `tslint.json` file
```json
{
"extends": [
@ -27,7 +28,7 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting
### Install Dependencies
If you don't have yarn workspaces enabled - enable them:
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```

12
packages/web3-wrapper/README.md
View File

@ -1,7 +1,7 @@
@0xproject/web3-wrapper
------
Wrapped version of web3 with nicer interface to be used across 0x projects and packages
Wrapped version of web3 with a nicer interface that is used across 0x projects and packages
## Installation
@ -11,7 +11,13 @@ yarn add @0xproject/web3-wrapper
## Usage
TODO - Custom documentation page is in progress.
```typescript
import {Web3Wrapper} from '@0xproject/web3-wrapper';
const web3 = ...;
const web3Wrapper = new Web3Wrapper(web3.currentProvider);
const availableAddresses = await web3Wrapper.getAvailableAddressesAsync();
```
## Contributing
@ -21,7 +27,7 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting
### Install Dependencies
If you don't have yarn workspaces enabled - enable them:
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```