Skip to content
This repository was archived by the owner on Mar 25, 2021. It is now read-only.

Commit a65f9b3

Browse files
authored
Minor README tweaks
1 parent 2cf0fa3 commit a65f9b3

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
[![NPM version](https://badge.fury.io/js/tslint.svg)](http://badge.fury.io/js/tslint)
22
[![Downloads](http://img.shields.io/npm/dm/tslint.svg)](https://npmjs.org/package/tslint)
33
[![Circle CI](https://circleci.com/gh/palantir/tslint.svg?style=svg)](https://circleci.com/gh/palantir/tslint)
4-
[![Join the chat at https://gitter.im/palantir/tslint](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/palantir/tslint?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
54

65
TSLint
76
======
@@ -10,9 +9,10 @@ TSLint is an extensible static analysis tool that checks [TypeScript](https://gi
109

1110
TSLint supports:
1211

12+
- an extensive set of core rules
1313
- custom lint rules
1414
- custom formatters (failure reporters)
15-
- inline disabling and enabling of rules with comment flags
15+
- inline disabling and enabling of rules with comment flags in source code
1616
- configuration presets (`tslint:latest`, `tslint-react`, etc.) and plugin composition
1717
- automatic fixing of formatting & style violations
1818
- integration with [MSBuild](https://github.com/joshuakgoldberg/tslint.msbuild), [Grunt](https://github.com/palantir/grunt-tslint), [Gulp](https://github.com/panuhorsmalahti/gulp-tslint), [Atom](https://github.com/AtomLinter/linter-tslint), [Eclipse](https://github.com/palantir/eclipse-tslint), [Emacs](http://flycheck.org), [Sublime](https://packagecontrol.io/packages/SublimeLinter-contrib-tslint), [Vim](https://github.com/scrooloose/syntastic), [Visual Studio 2015](https://marketplace.visualstudio.com/items?itemName=MadsKristensen.WebAnalyzer), [Visual Studio 2017](https://marketplace.visualstudio.com/items?itemName=RichNewman.TypeScriptAnalyzer), [Visual Studio code](https://marketplace.visualstudio.com/items?itemName=eg2.tslint), [WebStorm](https://www.jetbrains.com/webstorm/help/tslint.html) and [more](https://palantir.github.io/tslint/usage/third-party-tools/)
@@ -49,10 +49,10 @@ If we don't have all the rules you're looking for, you can either write your own
4949
Development
5050
-----------
5151

52-
Requirements:
52+
Prerequisites:
5353

54-
- `node` v7
55-
- `yarn` v0.23+
54+
- `node` v7+
55+
- `yarn` v1.0+
5656

5757
#### Quick Start
5858

@@ -68,7 +68,7 @@ Creating a new release
6868

6969
1. Bump the version number in `package.json` and `src/linter.ts`
7070
2. Add release notes in `CHANGELOG.md`
71-
- Use `./scripts/generate-changelog.js` (after building it with `tsc -p scripts`) to generate the changelog diff. This script expects a Github.com personal access token to exist at `~/github_token.txt` with "repo" permissions.
71+
- Use `./scripts/generate-changelog.js` (after building it with `tsc -p scripts`) to generate the changelog diff. This script expects a [Github.com personal access token](https://github.com/settings/tokens) to exist at `~/github_token.txt` with "repo" permissions.
7272
4. Commit with message `Prepare release <version>`
7373
5. Push your branch to GitHub and make a PR
7474
6. Once your PR is merged, wait for the tests to pass on CircleCI for develop

0 commit comments

Comments
 (0)