From ca2bb60877dbefc2e4ed07f2a437cfc89538e133 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Tue, 19 Dec 2017 12:55:48 -0500 Subject: Update readmes for connect, kovan-facuets, types, and utils packages --- packages/connect/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) (limited to 'packages/connect') 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 +``` -- cgit v1.2.3 From f239522a19b046b2eb3e6961ac2829dfa5d611e8 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Tue, 19 Dec 2017 17:50:54 -0500 Subject: Update some wording and remove N/A test sections --- packages/connect/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'packages/connect') diff --git a/packages/connect/README.md b/packages/connect/README.md index b6a16a16c..4326ba158 100644 --- a/packages/connect/README.md +++ b/packages/connect/README.md @@ -16,9 +16,9 @@ yarn add @0xproject/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. +We strongly recommend the community 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) +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. ### Install Dependencies -- cgit v1.2.3 From 0be4e1e1b3a545b56aedc5c1052b260fb4035981 Mon Sep 17 00:00:00 2001 From: Brandon Millman Date: Wed, 20 Dec 2017 01:11:58 -0500 Subject: Fix wording --- packages/connect/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'packages/connect') diff --git a/packages/connect/README.md b/packages/connect/README.md index 4326ba158..dd2002af4 100644 --- a/packages/connect/README.md +++ b/packages/connect/README.md @@ -16,13 +16,13 @@ yarn add @0xproject/connect ## Contributing -We strongly recommend the community 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. +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 - enable them: +If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: ```bash yarn config set workspaces-experimental true ``` -- cgit v1.2.3 From a2bf19efc1d1aef67ac6da321fe36c53135c6555 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 20 Dec 2017 17:10:12 +0100 Subject: Publish - 0x.js@0.28.0 - @0xproject/abi-gen@0.0.3 - @0xproject/assert@0.0.8 - @0xproject/connect@0.3.1 - contracts@2.1.0 - @0xproject/dev-utils@0.0.2 - @0xproject/json-schemas@0.7.0 - @0xproject/kovan_faucets@1.0.1 - @0xproject/monorepo-scripts@0.1.1 - @0xproject/subproviders@0.1.1 - @0xproject/tslint-config@0.3.0 - @0xproject/types@0.1.1 - @0xproject/utils@0.1.1 - @0xproject/web3-wrapper@0.1.1 - @0xproject/website@0.0.3 --- packages/connect/package.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'packages/connect') 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", -- cgit v1.2.3