diff options
author | Fabio Berger <me@fabioberger.com> | 2017-12-20 22:18:15 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2017-12-20 22:18:15 +0800 |
commit | 972e1675f6490bc10e8d9fd64cce2f7945cd4840 (patch) | |
tree | 11bc2769c40cf38a62a5a305c0d36dc5a2baec12 /packages/tslint-config | |
parent | 05ee36876386764c76aa0d2359ba17258152097d (diff) | |
parent | 291e2c8fa0214d35b3829d3503d7c9067b9e26db (diff) | |
download | dexon-0x-contracts-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.gz dexon-0x-contracts-972e1675f6490bc10e8d9fd64cce2f7945cd4840.tar.zst dexon-0x-contracts-972e1675f6490bc10e8d9fd64cce2f7945cd4840.zip |
Merge branch 'development' of github.com:0xProject/0x.js into development
* 'development' of github.com:0xProject/0x.js:
Change contributing test
Fix yarn workspaces explanation
Change CONTRIBUTING section
Fix the headers
Address feedback
Write 4 README's
Diffstat (limited to 'packages/tslint-config')
-rw-r--r-- | packages/tslint-config/README.md | 57 |
1 files changed, 52 insertions, 5 deletions
diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index 38a6bce45..b27d05df0 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -1,10 +1,57 @@ -tslint-config -------------- +@0xproject/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 + +Add the following to your `tslint.json` file +```json +{ + "extends": [ + "@0xproject/tslint-config" + ] +} +``` + +## Contributing + +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. + +### 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 +``` + +### Build + +```bash +yarn build +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test ``` |