aboutsummaryrefslogtreecommitdiffstats
path: root/packages/web3-wrapper/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/web3-wrapper/README.md')
-rw-r--r--packages/web3-wrapper/README.md55
1 files changed, 51 insertions, 4 deletions
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md
index 0df8c6333..5b22aefd4 100644
--- a/packages/web3-wrapper/README.md
+++ b/packages/web3-wrapper/README.md
@@ -1,10 +1,57 @@
-Web3 wrapper
-------
+## @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
-## Install
+## Installation
```bash
yarn add @0xproject/web3-wrapper
```
+
+## 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.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+### Install Dependencies
+
+If you don't have yarn workspaces enabled (Yarn < v1.0) - 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
+
+```bash
+yarn test
+```