diff options
author | Brandon Millman <brandon.millman@gmail.com> | 2017-12-20 01:55:48 +0800 |
---|---|---|
committer | Brandon Millman <brandon.millman@gmail.com> | 2017-12-20 01:55:48 +0800 |
commit | ca2bb60877dbefc2e4ed07f2a437cfc89538e133 (patch) | |
tree | d8929107f010284dba9ff6d7ac89cee8483a0c33 /packages/connect/README.md | |
parent | 1316a2dd2a8971771f750d8a7f457212daad520b (diff) | |
download | dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.tar dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.tar.gz dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.tar.bz2 dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.tar.lz dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.tar.xz dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.tar.zst dexon-0x-contracts-ca2bb60877dbefc2e4ed07f2a437cfc89538e133.zip |
Update readmes for connect, kovan-facuets, types, and utils packages
Diffstat (limited to 'packages/connect/README.md')
-rw-r--r-- | packages/connect/README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/packages/connect/README.md b/packages/connect/README.md index 900045526..b6a16a16c 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 encourage our community members to help us make improvements and to determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository. + +[CONTRIBUTING.md](../../CONTRIBUTING.md) + +### Install Dependencies + +If you don't have yarn workspaces enabled - 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 +``` |