aboutsummaryrefslogtreecommitdiffstats
path: root/packages/connect
diff options
context:
space:
mode:
Diffstat (limited to 'packages/connect')
-rw-r--r--packages/connect/README.md50
-rw-r--r--packages/connect/package.json8
2 files changed, 54 insertions, 4 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
+```
diff --git a/packages/connect/package.json b/packages/connect/package.json
index 39c94779e..bf92f07d2 100644
--- a/packages/connect/package.json
+++ b/packages/connect/package.json
@@ -1,6 +1,6 @@
{
"name": "@0xproject/connect",
- "version": "0.3.0",
+ "version": "0.3.1",
"description": "A javascript library for interacting with the standard relayer api",
"keywords": [
"connect",
@@ -36,8 +36,8 @@
},
"homepage": "https://github.com/0xProject/0x.js/packages/connect/README.md",
"dependencies": {
- "@0xproject/assert": "^0.0.7",
- "@0xproject/json-schemas": "^0.6.10",
+ "@0xproject/assert": "^0.0.8",
+ "@0xproject/json-schemas": "^0.7.0",
"bignumber.js": "~4.1.0",
"isomorphic-fetch": "^2.2.1",
"lodash": "^4.17.4",
@@ -45,7 +45,7 @@
"websocket": "^1.0.25"
},
"devDependencies": {
- "@0xproject/tslint-config": "^0.2.1",
+ "@0xproject/tslint-config": "^0.3.0",
"@types/fetch-mock": "^5.12.1",
"@types/lodash": "^4.14.86",
"@types/mocha": "^2.2.42",