diff options
| author | Leonid Logvinov <logvinov.leon@gmail.com> | 2017-12-19 23:53:41 +0800 |
|---|---|---|
| committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2017-12-20 21:07:50 +0800 |
| commit | de6fe257518e661b35df080ab54b1adc6819af5b (patch) | |
| tree | 9af9fdad18d208ed6837630db3c9672ad1bdd591 /packages/tslint-config/README.md | |
| parent | b603197ae837dca86d712760f9b18f626628096a (diff) | |
| download | dexon-sol-tools-de6fe257518e661b35df080ab54b1adc6819af5b.tar.gz dexon-sol-tools-de6fe257518e661b35df080ab54b1adc6819af5b.tar.zst dexon-sol-tools-de6fe257518e661b35df080ab54b1adc6819af5b.zip | |
Write 4 README's
Diffstat (limited to 'packages/tslint-config/README.md')
| -rw-r--r-- | packages/tslint-config/README.md | 44 |
1 files changed, 40 insertions, 4 deletions
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` |