aboutsummaryrefslogtreecommitdiffstats
path: root/packages/connect/README.md
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2017-12-21 08:07:54 +0800
committerBrandon Millman <brandon.millman@gmail.com>2017-12-21 08:07:54 +0800
commit23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a (patch)
tree12359f3dbefa5fc1948821ad53f21096730aad9c /packages/connect/README.md
parentcb11aec84df346d5180c7d5874859c1c34f0bf1c (diff)
parent42b3a7c9d756dd2c68256707c0c96a95370329bd (diff)
downloaddexon-sol-tools-23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a.tar
dexon-sol-tools-23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a.tar.gz
dexon-sol-tools-23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a.tar.bz2
dexon-sol-tools-23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a.tar.lz
dexon-sol-tools-23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a.tar.xz
dexon-sol-tools-23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a.tar.zst
dexon-sol-tools-23052a5c2efdb51f8d991a5a3bd77b3c3cdc6a9a.zip
Merge branch 'development' into fix/underscorePrivate
* development: (29 commits) Move call to error reporter to end of handler so that even if reporting the error takes a while, it doesn't block the UI Update outdated WETH ranges Fix conditional Fix top-padding Publish Update CHANGELOGs Add slashes to base URLs Fix linter issue Fix WETH symbol Update snapshot and artifacts Replace our EtherTokens with WETH9 from maker Fix test description Fix a typo Add err==null assertions Add WETH9 tests Use the new snapshot including WETH9 and it's artifacts Add WETH9 and mirations Fix WETH events watching Fix a typo Init the _etherTokenContractsByAddress ...
Diffstat (limited to 'packages/connect/README.md')
-rw-r--r--packages/connect/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/packages/connect/README.md b/packages/connect/README.md
index 900045526..dd2002af4 100644
--- a/packages/connect/README.md
+++ b/packages/connect/README.md
@@ -1 +1,51 @@
+@0xproject/connect
+------
+
This repository contains a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api)
+
+## Installation
+
+```bash
+yarn add @0xproject/connect
+```
+
+## Usage
+
+* [Docs](https://0xproject.com/docs/connect)
+* [Tutorials](https://0xproject.com/wiki#connect)
+
+## Contributing
+
+We strongly recommend 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
+```