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 +++++++++++++++++++++++++++++++++++++++ packages/kovan-faucets/README.md | 46 ++++++++++++++++++++++++++---------- packages/types/README.md | 51 +++++++++++++++++++++++++++++++++++++--- packages/utils/README.md | 50 +++++++++++++++++++++++++++++++++++++-- 4 files changed, 180 insertions(+), 17 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 +``` diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md index 8903440e3..70600fc9c 100644 --- a/packages/kovan-faucets/README.md +++ b/packages/kovan-faucets/README.md @@ -1,22 +1,35 @@ -Test Ether Faucet ----------------------- +@0xproject/kovan_faucets +------ This faucet dispenses 0.1 test ether to one recipient per second. It has a max queue size of 1000. +## Installation -## Install +This is a private package and therefore is not published to npm. In order to build and run this package locally, see the [Install Dependencies](#Install-Dependencies) section and onwards below. -Install project dependencies: +## 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 ``` -npm install + +Then install dependencies +```bash +yarn install ``` -## Start +### Start Set the following environment variables: -``` +```bash export FAUCET_ENVIRONMENT=development export DISPENSER_ADDRESS=0x5409ed021d9299bf6814279a6a1411a7e866a631 export DISPENSER_PRIVATE_KEY=f2f48ee19680706196e2e339e5da3491186e0c4c5030670656b0e0164837257d @@ -28,11 +41,11 @@ Infura API Key can be requested here: https://infura.io/register.html Note: The above public/private keys exist when running `testrpc` with the following option `--mnemonic concert load couple harbor equip island argue ramp clarify fence smart topic`. -``` -npm run dev +```bash +yarn dev ``` -## Endpoints +### Endpoints ```GET /ether/:recipient``` @@ -42,7 +55,6 @@ Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. - ```javascript { "full": false, @@ -50,7 +62,7 @@ Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. } ``` -## Docker configs +### Docker configs ``` docker run -d \ @@ -64,3 +76,13 @@ docker run -d \ -e FAUCET_ENVIRONMENT=production \ kovan-faucets ``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +N/A diff --git a/packages/types/README.md b/packages/types/README.md index d4d48b1fe..3352128a3 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -1,10 +1,55 @@ -0x types +@0xproject/types ------ -TS types shared across 0x projects and packages +Typescript types shared across 0x projects and packages -## Install +## Installation ```bash yarn add -D @0xproject/types ``` + +## Usage + +```javascript +import { + TransactionReceipt, + TxData, + TxDataPayable, +} from '@0xproject/types'; +``` + + +## 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 + +N/A diff --git a/packages/utils/README.md b/packages/utils/README.md index 5191e0350..c80c6baf5 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -1,10 +1,56 @@ -utils +@0xproject/utils ------ Utils to be shared across 0x projects and packages -## Install +## Installation ```bash yarn add @0xproject/utils ``` + +## Usage + +```javascript +import { + addressUtils, + bigNumberConfigs, + classUtils, + intervalUtils, + promisify, +} from '@0xproject/utils'; +``` + +## 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 + +N/A -- cgit 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 ++-- packages/kovan-faucets/README.md | 17 +++-------------- packages/types/README.md | 8 ++------ packages/utils/README.md | 8 ++------ 4 files changed, 9 insertions(+), 28 deletions(-) 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 diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md index 70600fc9c..7c4177b9f 100644 --- a/packages/kovan-faucets/README.md +++ b/packages/kovan-faucets/README.md @@ -1,7 +1,7 @@ @0xproject/kovan_faucets ------ -This faucet dispenses 0.1 test ether to one recipient per second. It has a max queue size of 1000. +This faucet dispenses 0.1 test ether to one recipient per second and 0.1 test ZRX every 5 seconds. It has a max queue size of 1000. ## Installation @@ -9,9 +9,9 @@ This is a private package and therefore is not published to npm. In order to bui ## 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 @@ -55,13 +55,6 @@ Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. Where recipient_address is a hex encoded Ethereum address prefixed with `0x`. -```javascript -{ - "full": false, - "size": 0 -} -``` - ### Docker configs ``` @@ -82,7 +75,3 @@ kovan-faucets ```bash yarn lint ``` - -### Run Tests - -N/A diff --git a/packages/types/README.md b/packages/types/README.md index 3352128a3..eb27ce967 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -22,9 +22,9 @@ import { ## 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 @@ -49,7 +49,3 @@ yarn build ```bash yarn lint ``` - -### Run Tests - -N/A diff --git a/packages/utils/README.md b/packages/utils/README.md index c80c6baf5..39b6eab46 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -23,9 +23,9 @@ import { ## 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 @@ -50,7 +50,3 @@ yarn build ```bash yarn lint ``` - -### Run Tests - -N/A -- cgit 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 ++-- packages/kovan-faucets/README.md | 4 ++-- packages/types/README.md | 4 ++-- packages/utils/README.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) 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 ``` diff --git a/packages/kovan-faucets/README.md b/packages/kovan-faucets/README.md index 7c4177b9f..111e88302 100644 --- a/packages/kovan-faucets/README.md +++ b/packages/kovan-faucets/README.md @@ -9,13 +9,13 @@ This is a private package and therefore is not published to npm. In order to bui ## 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 ``` diff --git a/packages/types/README.md b/packages/types/README.md index eb27ce967..c549a736f 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -22,13 +22,13 @@ import { ## 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 e`nabled (Yarn < v1.0) - enable them: ```bash yarn config set workspaces-experimental true ``` diff --git a/packages/utils/README.md b/packages/utils/README.md index 39b6eab46..f56c6c4e7 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -23,13 +23,13 @@ import { ## 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