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

Make docs link more discoverable in README, move docs out of README

Browse Source
This commit is contained in:
Fabio Berger 2018-03-20 22:24:26 +00:00
parent 6a410b03ff
commit 38f716bd77
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,6 +1,8 @@
## @0xproject/web3-wrapper ## @0xproject/web3-wrapper
Wrapped version of web3 with a nicer interface that is used across 0x projects and packages. Visit [the docs](0xproject.com/docs/web3_wrapper). Wrapped version of web3 with a nicer interface that is used across 0x projects and packages.
### Read the [ Documentation](0xproject.com/docs/web3_wrapper).
## Installation ## Installation
@ -16,16 +18,6 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol
] ]
``` ```
## Usage
```typescript
import {Web3Wrapper} from '@0xproject/web3-wrapper';
const web3 = ...;
const web3Wrapper = new Web3Wrapper(web3.currentProvider);
const availableAddresses = await web3Wrapper.getAvailableAddressesAsync();
```
## Contributing ## Contributing
We strongly encourage 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. We strongly encourage 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.

8
packages/website/md/docs/web3_wrapper/installation.md
View File

@ -15,3 +15,11 @@ or
```javascript ```javascript
var Web3Wrapper = require('@0xproject/web3-wrapper').Web3Wrapper; var Web3Wrapper = require('@0xproject/web3-wrapper').Web3Wrapper;
``` ```
If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
```
"include": [
"./node_modules/web3-typescript-typings/index.d.ts",
]
```