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

Commit 002b259

Browse files
Enhance README to be more readable
1 parent 38c6e83 commit 002b259

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
[eslint-url]: http://eslint.org
2+
[travis-badge]: https://travis-ci.org/strvcom/eslint-config-javascript.svg
3+
[travis-url]: https://travis-ci.org/strvcom/eslint-config-javascript
4+
[eslint-version]: https://img.shields.io/badge/ESLint->=4.6.0-brightgreen.svg
5+
[eslint-fixing]: http://eslint.org/docs/user-guide/command-line-interface#fix
6+
[flow-home]: https://flow.org
7+
[react-home]: http://reactjs.com
8+
[nodejs-home]: https://nodejs.org
9+
10+
111
# JavaScript Coding Standards
212

313
> Write bulletproof JavaScript like a pro! 😎
@@ -32,43 +42,36 @@ See the [tutorial](tutorial) directory for lots of example config files.
3242

3343
### Available rulesets
3444

35-
> These are for Node.js code.
45+
#### For [Node.js][nodejs-home]
3646

3747
- @strv/javascript/environments/nodejs/v8-3
3848
- @strv/javascript/environments/nodejs/v8
3949
- @strv/javascript/environments/nodejs/v7
4050
- @strv/javascript/environments/nodejs/v6
4151
- @strv/javascript/environments/nodejs/optional
4252

43-
> These are for browser-specific code which uses React.
53+
#### For [React][react-home]
4454

4555
- @strv/javascript/environments/react/v15
4656
- @strv/javascript/environments/react/optional
4757
- @strv/javascript/environments/react/accessibility
58+
> This one contains rules specific to web accessibility best practices.
4859
49-
> These are rules for [Flow][flow-home] type checker.
50-
- @strv/javascript/environments/flow/recommended
60+
#### For [Flow][flow-home]
5161

52-
> This one includes rules which deal with how the code looks like and not how it works. It helps keep the code clean and consistent.
62+
- @strv/javascript/environments/flow/recommended
5363

54-
- @strv/javascript/coding-styles/recommended
64+
#### Coding styles
5565

56-
> This is a subset of the `recommended` coding style ruleset and includes only rules which [ESLint can fix automatically][eslint-fixing]. This is great for gradual adoption of coding style rulesets into existing projects.
66+
These rulesets include rules which deal with how the code looks like and not how it works. They help keep the code clean and consistent.
5767

68+
- @strv/javascript/coding-styles/recommended
5869
- @strv/javascript/coding-styles/fixable
59-
60-
> This one contains coding style rules for Flow
70+
> This is a subset of the `recommended` coding style ruleset and includes only rules which [ESLint can fix automatically][eslint-fixing]. This is great for gradual adoption of coding style rulesets into existing projects.
6171
6272
- @strv/javascript/coding-styles/flow
73+
> This one contains coding style rules for code using Flow
6374
6475
## License
6576

6677
This software is licensed under the **BSD-3-Clause License**. See the [LICENSE](LICENSE) file for more information.
67-
68-
69-
[eslint-url]: http://eslint.org
70-
[travis-badge]: https://travis-ci.org/strvcom/eslint-config-javascript.svg
71-
[travis-url]: https://travis-ci.org/strvcom/eslint-config-javascript
72-
[eslint-version]: https://img.shields.io/badge/ESLint->=4.6.0-brightgreen.svg
73-
[eslint-fixing]: http://eslint.org/docs/user-guide/command-line-interface#fix
74-
[flow-home]: https://flow.org

0 commit comments

Comments
 (0)