Skip to content

Commit

Permalink
Small README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
adidahiya committed Feb 22, 2016
1 parent bbb05b0 commit 8e4822f
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,33 @@
TSLint
======

A linter for the TypeScript language.
An extensible linter for the TypeScript language.

Supports:

- custom rules
- custom formatters
- inline disabling / enabling of rules
- integration with [grunt](https://github.com/palantir/grunt-tslint), [gulp](https://github.com/panuhorsmalahti/gulp-tslint), [atom](https://github.com/AtomLinter/linter-tslint), [sublime](https://packagecontrol.io/packages/SublimeLinter-contrib-tslint), [vim](https://github.com/scrooloose/syntastic), [eclipse](https://github.com/palantir/eclipse-tslint), [webstorm](https://www.jetbrains.com/webstorm/help/tslint.html), and more

Installation
------------

##### CLI

```
npm install tslint -g
npm install typescript -g
npm install -g tslint typescript
```

##### Library

```
npm install tslint
npm install typescript
npm install tslint typescript
```

##### Peer dependencies

The `typescript` module is a peer dependency of TSLint, which allows you to update the compiler independently from the
`typescript` is a peer dependency of `tslint`. This allows you to update the compiler independently from the
linter. This also means that `tslint` will have to use the same version of `tsc` used to actually compile your sources.

Breaking changes in the latest dev release of `typescript@next` might break something in the linter if we haven't built against that release yet. If this happens to you, you can try:
Expand Down Expand Up @@ -370,9 +375,9 @@ version of TSLint via `npm install tslint@next`.
Creating a new Release
----------------------

1. Bump up the version number in `package.json` and `tslint.ts`
1. Bump the version number in `package.json` and `src/tslint.ts`
2. Add a section for the new release in `CHANGELOG.md`
3. Run `grunt` to build the latest sources
4. Commit
4. Commit with message "Prepare release <version>"
5. Run `npm publish`
6. Create a git tag for the new release and push it

0 comments on commit 8e4822f

Please sign in to comment.