Skip to content

Commit dbff06d

Browse files
sapeginazu
authored andcommitted
docs: Tweak readme a bit (#6)
1 parent 6cff9c1 commit dbff06d

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# textlint-rule-eslint [![Build Status](https://travis-ci.org/azu/textlint-rule-eslint.svg?branch=master)](https://travis-ci.org/azu/textlint-rule-eslint) [![textlint fixable rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/)
22

33

4-
[textlint](https://textlint.github.io/ "textlint official site") rule integrate with ESLint.
4+
[textlint](https://textlint.github.io/ "textlint official site") rule to lint JavaScript in Markdown with ESLint.
55

6-
## UseCase
6+
## Use case
77

8-
ESLint can lint markdown file using [eslint/eslint-plugin-markdown](https://github.com/eslint/eslint-plugin-markdown "eslint/eslint-plugin-markdown").
9-
But, eslint-plugin-markdown don't support disabling Markdown(HTML) comment for ignoring some CodeBlock.
8+
ESLint can lint Markdown files using [eslint-plugin-markdown](https://github.com/eslint/eslint-plugin-markdown "eslint/eslint-plugin-markdown"). But eslint-plugin-markdown doesn't support disabling Markdown (HTML) comments for ignoring some CodeBlocks.
109

11-
[textlint](https://textlint.github.io/ "textlint official site") can filter specified CodeBlock using [textlint-filter-rule-comments](https://github.com/textlint/textlint-filter-rule-comments "textlint-filter-rule-comments").
10+
[textlint](https://textlint.github.io/ "textlint official site") can filter some CodeBlocks using [textlint-filter-rule-comments](https://github.com/textlint/textlint-filter-rule-comments "textlint-filter-rule-comments"):
1211

1312
<!-- textlint-disable -->
1413

@@ -19,7 +18,7 @@ But, eslint-plugin-markdown don't support disabling Markdown(HTML) comment for i
1918
<!-- textlint-enable -->
2019

2120

22-
Sometimes, we want to write broken JavaScript code into JS CodeBlock for Syntax Highlight.
21+
Sometimes, we want to write broken JavaScript code into a JS CodeBlock for syntax highlight:
2322

2423

2524
This is error example of parsing:
@@ -33,7 +32,7 @@ Sometimes, we want to write broken JavaScript code into JS CodeBlock for Syntax
3332

3433
<!-- textlint-enable eslint -->
3534

36-
## Install
35+
## Installation
3736

3837
Install with [npm](https://www.npmjs.com/):
3938

@@ -42,7 +41,7 @@ Install with [npm](https://www.npmjs.com/):
4241
## Usage
4342

4443

45-
Via `.textlintrc`(Recommended)
44+
Via `.textlintrc` (recommended):
4645

4746
```js
4847
{
@@ -55,7 +54,7 @@ Via `.textlintrc`(Recommended)
5554
}
5655
```
5756

58-
Via CLI
57+
Via CLI:
5958

6059
```
6160
textlint --rule eslint README.md

0 commit comments

Comments
 (0)