From 38f716bd77c46e55ad117cfef8cb42474e61a7c0 Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Tue, 20 Mar 2018 22:24:26 +0000 Subject: Make docs link more discoverable in README, move docs out of README --- packages/web3-wrapper/README.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) (limited to 'packages/web3-wrapper') diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 244e20708..c63982703 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -1,6 +1,8 @@ ## @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 @@ -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 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. -- cgit v1.2.3