aboutsummaryrefslogtreecommitdiffstats
path: root/packages/tslint-config/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-01-10 18:23:03 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-01-10 18:23:03 +0800
commita767c353d25588cf5802868ee7b3710e99316e96 (patch)
treea4d2bbf93e082a719007f8cc5903ce2028fd32b2 /packages/tslint-config/README.md
parenta39d3d723399e124ae617dfda67e754907312a98 (diff)
parentc700046b7673a0f470c8d8abeec3cf873049a78a (diff)
downloaddexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.gz
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.bz2
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.lz
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.xz
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.tar.zst
dexon-sol-tools-a767c353d25588cf5802868ee7b3710e99316e96.zip
Merge branch 'fix/prettify_json' into development
Diffstat (limited to 'packages/tslint-config/README.md')
-rw-r--r--packages/tslint-config/README.md10
1 files changed, 5 insertions, 5 deletions
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
```