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/utils/README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) (limited to 'packages/utils/README.md') 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 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/utils/README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'packages/utils/README.md') 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 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/utils/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'packages/utils/README.md') 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 v1.2.3 From c700046b7673a0f470c8d8abeec3cf873049a78a Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Thu, 4 Jan 2018 12:54:16 +0100 Subject: Apply prettify on json and md files --- packages/utils/README.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) (limited to 'packages/utils/README.md') diff --git a/packages/utils/README.md b/packages/utils/README.md index f56c6c4e7..d6cacfa11 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -1,5 +1,4 @@ -@0xproject/utils ------- +## @0xproject/utils Utils to be shared across 0x projects and packages @@ -12,13 +11,7 @@ yarn add @0xproject/utils ## Usage ```javascript -import { - addressUtils, - bigNumberConfigs, - classUtils, - intervalUtils, - promisify, -} from '@0xproject/utils'; +import { addressUtils, bigNumberConfigs, classUtils, intervalUtils, promisify } from '@0xproject/utils'; ``` ## Contributing @@ -30,11 +23,13 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting ### 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 ``` -- cgit v1.2.3