Skip to content

Commit

Permalink
Added Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
michalstocki committed Sep 11, 2017
1 parent 57f5fbf commit a2410bc
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# tslint-config-uxpin

UXPin recommended TSLint configuration.

## Installation

Install TSLint and `tslint-config-uxpin`:

yarn add --dev tslint tslint-config-uxpin

or

npm install tslint tslint-config-uxpin --save-dev

Then create a `tslint.json` file in the root directory of your package, with the following contents:

```json
{
"extends": "tslint-config-uxpin"
}
```

## Customization

In some cases, default configuration of the `tslint-config-uxpin` may not fit specifics of your projects. In most cases it's unrecommended but still possible to override the default configuration:

```json
{
"extends": "tslint-config-uxpin",
"rules": {
"no-default-export": false,
"match-default-export-name": true
}
}
```

0 comments on commit a2410bc

Please sign in to comment.