aboutsummaryrefslogtreecommitdiffstats
path: root/packages/web3-wrapper
diff options
context:
space:
mode:
authorLeonid <logvinov.leon@gmail.com>2017-12-20 22:17:23 +0800
committerGitHub <noreply@github.com>2017-12-20 22:17:23 +0800
commit291e2c8fa0214d35b3829d3503d7c9067b9e26db (patch)
treec254a750285abdb9cf9a92c03224a1dddb5cb3df /packages/web3-wrapper
parentad61fe4b5455b2fe700f8777c0133e3f45ea4ebd (diff)
parentbf1603839ee5b7e8a1b1db32a0d037b3680a38d6 (diff)
downloaddexon-0x-contracts-291e2c8fa0214d35b3829d3503d7c9067b9e26db.tar.gz
dexon-0x-contracts-291e2c8fa0214d35b3829d3503d7c9067b9e26db.tar.zst
dexon-0x-contracts-291e2c8fa0214d35b3829d3503d7c9067b9e26db.zip
Merge pull request #279 from 0xProject/feature/READMEs
Write 4 README's
Diffstat (limited to 'packages/web3-wrapper')
-rw-r--r--packages/web3-wrapper/README.md52
1 files changed, 49 insertions, 3 deletions
diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md
index 0df8c6333..c6e2163a3 100644
--- a/packages/web3-wrapper/README.md
+++ b/packages/web3-wrapper/README.md
@@ -1,10 +1,56 @@
-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
+```