Skip to content

Commit e4a652f

Browse files
committed
Update project README
- Update project/documentation links - Use open source Code Climate badge - Hard-wrap text - Fix YAML identation
1 parent f9f1b4f commit e4a652f

File tree

1 file changed

+39
-12
lines changed

1 file changed

+39
-12
lines changed

README.md

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,57 @@
11
# Code Climate ESLint Engine
22

3-
[![Code Climate](https://codeclimate.com/repos/55841b7a6956801212006c92/badges/92d8261f1b6200f19af5/gpa.svg)](https://codeclimate.com/repos/55841b7a6956801212006c92/feed)
3+
[![Code Climate][badge]][repo]
44

5-
`codeclimate-eslint` is a Code Climate engine that wraps [ESLint](https://github.com/eslint/eslint). You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.
5+
[badge]: https://codeclimate.com/github/codeclimate/codeclimate-eslint/badges/gpa.svg
6+
[repo]: https://codeclimate.com/repos/github/codeclimate-eslint
67

7-
ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. It can be configured using a [configuration file](https://github.com/eslint/eslint#usage).
8+
`codeclimate-eslint` is a Code Climate engine that wraps [ESLint][]. You can run
9+
it on your command line using the Code Climate CLI, or on our hosted analysis
10+
platform.
11+
12+
ESLint is a tool for identifying and reporting on patterns found in
13+
ECMAScript/JavaScript code. It can be configured using a [configuration
14+
file][config].
15+
16+
[config]: http://eslint.org/docs/user-guide/configuring#using-configuration-files
817

918
### Installation
1019

11-
1. If you haven't already, [install the Code Climate CLI](https://github.com/codeclimate/codeclimate).
12-
2. Run `codeclimate engines:enable eslint`. This command both installs the engine and enables it in your `.codeclimate.yml` file.
13-
3. You're ready to analyze! Browse into your project's folder and run `codeclimate analyze`.
20+
1. If you haven't already, [install the Code Climate CLI][CLI]
21+
22+
2. Run `codeclimate engines:enable eslint`. This command both installs the
23+
engine and enables it in your `.codeclimate.yml` file
24+
25+
3. You're ready to analyze! Browse into your project's folder and run
26+
`codeclimate analyze`
27+
28+
[cli]: https://github.com/codeclimate/codeclimate
1429

1530
### Configuration
1631

1732
#### `ignore_warnings`
18-
By default, this engine will emit both ESLint errors and warnings as Code Climate issues. If you prefer, you can ignore warning-level violations by setting the `ignore_warnings` configuration option:
33+
34+
By default, this engine will emit both ESLint errors and warnings as Code
35+
Climate issues. If you prefer, you can ignore warning-level violations by
36+
setting the `ignore_warnings` configuration option:
37+
1938
```yaml
2039
eslint:
21-
enabled: true
22-
config:
23-
ignore_warnings: true
40+
enabled: true
41+
config:
42+
ignore_warnings: true
2443
```
2544
2645
### Need help?
2746
28-
For help with ESLint, [check out their documentation](https://github.com/eslint/eslint).
47+
For help with ESLint, [check out their documentation][eslint-docs].
48+
49+
If you're running into a Code Climate issue, first look over this project's
50+
[GitHub Issues][issues], as your question may have already been covered. If not,
51+
[go ahead and open a support ticket with us][help].
52+
53+
[issues]: https://github.com/codeclimate/codeclimate-eslint/issues
54+
[help]: https://codeclimate.com/help
2955
30-
If you're running into a Code Climate issue, first look over this project's [GitHub Issues](https://github.com/codeclimate/codeclimate-eslint/issues), as your question may have already been covered. If not, [go ahead and open a support ticket with us](https://codeclimate.com/help).
56+
[eslint]: http://eslint.org
57+
[eslint-docs]: http://eslint.org/docs/user-guide/

0 commit comments

Comments
 (0)