Skip to content

Commit

Permalink
Minor README edits
Browse files Browse the repository at this point in the history
  • Loading branch information
adidahiya authored May 31, 2017
1 parent 7fc3d62 commit f9e05e4
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,21 @@ TSLint supports:

- custom lint rules
- custom formatters (failure reporters)
- inline disabling and enabling of rules
- configuration presets (`tslint:latest`, `tslint-react`, etc.) & composition
- inline disabling and enabling of rules with comment flags
- configuration presets (`tslint:latest`, `tslint-react`, etc.) and plugin composition
- automatic fixing of formatting & style violations
- 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](https://visualstudiogallery.msdn.microsoft.com/6edc26d4-47d8-4987-82ee-7c820d79be1d), [vscode](https://marketplace.visualstudio.com/items?itemName=eg2.tslint), [webstorm](https://www.jetbrains.com/webstorm/help/tslint.html), and more

Installation & Usage
------------

Refer to the full installation & usage documentation on the [TSLint website](https://palantir.github.io/tslint/).

There, you'll find information about
Please refer to the full installation & usage documentation on the [TSLint website](https://palantir.github.io/tslint/). There, you'll find information about
- [configuration](https://palantir.github.io/tslint/usage/configuration/),
- [core rules](https://palantir.github.io/tslint/),
- [core formatters](http://palantir.github.io/tslint/formatters/), and
- [core rules](https://palantir.github.io/tslint/rules/),
- [core formatters](https://palantir.github.io/tslint/formatters/), and
- [customization of TSLint](https://palantir.github.io/tslint/develop/custom-rules/).

Custom Rules
Custom Rules & Plugins
------------

#### Custom rule sets from Palantir
Expand All @@ -38,7 +36,7 @@ Custom Rules

#### Custom rule sets from the community

If we don't have all the rules you're looking for, you can either write your own custom rules or use custom rules that others have developed. The repos below are a good source of custom rules:
If we don't have all the rules you're looking for, you can either write your own [custom rules](https://palantir.github.io/tslint/develop/custom-rules/) or use rules implementations developed by the community. The repos below are a good source of custom rules:

- [ESLint rules for TSLint](https://github.com/buzinas/tslint-eslint-rules) - Improve your TSLint with the missing ESLint Rules
- [tslint-microsoft-contrib](https://github.com/Microsoft/tslint-microsoft-contrib) - A set of TSLint rules used on some Microsoft projects
Expand All @@ -59,7 +57,7 @@ Requirements:

```bash
git clone [email protected]:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf
yarn install
yarn
yarn compile
yarn test
```
Expand All @@ -69,7 +67,7 @@ Creating a new release

1. Bump the version number in `package.json` and `src/tslintMulti.ts`
2. Add release notes in `CHANGELOG.md`
3. `yarn verify` to build the latest sources
3. `yarn verify` to build the latest sources from a clean state
4. Commit with message `Prepare release <version>`
5. Run `npm publish`
6. Create a git tag for the new release and push it ([see existing tags here](https://github.com/palantir/tslint/tags))

0 comments on commit f9e05e4

Please sign in to comment.