From de6fe257518e661b35df080ab54b1adc6819af5b Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 19 Dec 2017 16:53:41 +0100 Subject: Write 4 README's --- packages/tslint-config/README.md | 44 ++++++++++++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 4 deletions(-) (limited to 'packages/tslint-config/README.md') diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index 38a6bce45..b43525827 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -1,10 +1,46 @@ tslint-config -------------- +------ -Lint rules related to 0xProject for TSLint. +TSLint configuration and custom linter rules used by 0xProject. -## Install: +## Installation ```bash -npm install @0xproject/tslint-config --save-dev +yarn add --dev @0xproject/tslint-config ``` + +## Usage + +```json +{ + "extends": [ + "@0xproject/tslint-config" + ] +} +``` + +## 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: +`yarn config set workspaces-experimental true` + +Then install dependencies +`yarn install` + +## Build + +`yarn build` + +## Lint + +`yarn lint` + +## Run Tests + +`yarn test` -- cgit From ecc6cb2b7c8aff181341474830cd482579db7ca1 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 19 Dec 2017 18:03:44 +0100 Subject: Address feedback --- packages/tslint-config/README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) (limited to 'packages/tslint-config/README.md') diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index b43525827..ef4fba022 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -25,22 +25,32 @@ We strongly encourage our community members to help us make improvements and to [CONTRIBUTING.md](../../CONTRIBUTING.md) -## Install Dependencies +### Install Dependencies If you don't have yarn workspaces enabled - enable them: -`yarn config set workspaces-experimental true` +```bash +yarn config set workspaces-experimental true +``` Then install dependencies -`yarn install` +```bash +yarn install +``` -## Build +### Build -`yarn build` +```bash +yarn build +``` -## Lint +### Lint -`yarn lint` +```bash +yarn lint +``` -## Run Tests +### Run Tests -`yarn test` +```bash +yarn test +``` -- cgit From 3579f063d6fb09f7a091d3f896bd29edb84b3f55 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Tue, 19 Dec 2017 18:04:42 +0100 Subject: Fix the headers --- packages/tslint-config/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/tslint-config/README.md') diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index ef4fba022..f737062b2 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -1,4 +1,4 @@ -tslint-config +@0xproject/tslint-config ------ TSLint configuration and custom linter rules used by 0xProject. -- cgit From c3508dcdc6e2cf459bf076c0bb0087338cf96f7a Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 20 Dec 2017 14:10:35 +0100 Subject: Change CONTRIBUTING section --- packages/tslint-config/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/tslint-config/README.md') diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index f737062b2..bbd0fb0f2 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -23,7 +23,7 @@ yarn add --dev @0xproject/tslint-config 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) +Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started. ### Install Dependencies -- cgit From 8ed776e113f0e249d50aa9e74b459b770ff62cee Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 20 Dec 2017 14:17:17 +0100 Subject: Fix yarn workspaces explanation --- packages/tslint-config/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'packages/tslint-config/README.md') diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index bbd0fb0f2..e943bc0db 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -11,6 +11,7 @@ yarn add --dev @0xproject/tslint-config ## Usage +Add the following to your `tslint.json` file ```json { "extends": [ @@ -27,7 +28,7 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting ### 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 From bf1603839ee5b7e8a1b1db32a0d037b3680a38d6 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Wed, 20 Dec 2017 14:21:39 +0100 Subject: Change contributing test --- packages/tslint-config/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'packages/tslint-config/README.md') diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index e943bc0db..b27d05df0 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -22,7 +22,7 @@ Add the following to your `tslint.json` file ## 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 encourage 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. -- cgit 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/tslint-config/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'packages/tslint-config/README.md') diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index b27d05df0..8a6fa8a2f 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -1,5 +1,4 @@ -@0xproject/tslint-config ------- +## @0xproject/tslint-config TSLint configuration and custom linter rules used by 0xProject. @@ -12,11 +11,10 @@ yarn add --dev @0xproject/tslint-config ## Usage Add the following to your `tslint.json` file + ```json { - "extends": [ - "@0xproject/tslint-config" - ] + "extends": ["@0xproject/tslint-config"] } ``` @@ -29,11 +27,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