Skip to content

Commit b216a0a

Browse files
authored
docs: improve README grammar and formatting consistency (#16)
1 parent 0ec2f94 commit b216a0a

File tree

2 files changed

+50
-46
lines changed

2 files changed

+50
-46
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,29 @@
44

55
Extension to integrate [textlint](https://textlint.github.io/) into VS Code.
66

7-
## How to install
7+
## Installation
88

9-
1. Visit [Visual Studio Code: textlint](https://marketplace.visualstudio.com/items?itemName=3w36zj6.textlint)
10-
2. Click Install
9+
1. Visit [textlint - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=3w36zj6.textlint)
10+
2. Click the "Install" button
1111

1212
## Development setup
1313

14-
1. open `vscode-textlint.code-workspace` by VS Code
15-
2. run `npm ci` inside the **root** folder
16-
3. hit F5 to build and debug the extension
14+
1. Open `vscode-textlint.code-workspace` in VS Code
15+
2. Run `npm ci` in the **root** folder
16+
3. Press F5 to build and launch the extension in debug mode
1717

18-
## How to release
18+
## Release process
1919

20-
1. run `npm ci` inside the **root** folder
21-
2. run `npm run package` inside the **root** folder
22-
3. run `npx vsce publish --packagePath ./packages/textlint/textlint-*.vsix` inside the **root** folder
20+
1. Run `npm ci` in the **root** folder
21+
2. Run `npm run package` in the **root** folder
22+
3. Run `npx vsce publish --packagePath ./packages/textlint/textlint-*.vsix` in the **root** folder
2323

2424
## Acknowledgements
2525

26-
This project was originally created as [taichi/vscode-textlint](https://github.com/taichi/vscode-textlint). It has been transferred to the textlint organization since [v0.12.0](https://github.com/textlint/vscode-textlint/releases/tag/v0.12.0) for continued maintenance and development. We'd like to express our gratitude to [@taichi](https://github.com/taichi) and all contributors. For more details, please see [github.com/orgs/textlint/discussions/2](https://github.com/orgs/textlint/discussions/2).
26+
This project was originally created as [taichi/vscode-textlint](https://github.com/taichi/vscode-textlint).
27+
28+
Since [v0.12.0](https://github.com/textlint/vscode-textlint/releases/tag/v0.12.0), it has been transferred to the textlint organization for continued maintenance and development.
29+
30+
We'd like to express our gratitude to [@taichi](https://github.com/taichi) and all contributors. For more details, please see [github.com/orgs/textlint/discussions/2](https://github.com/orgs/textlint/discussions/2).
2731

2832
The [MIT License](LICENSE) from the upstream repository continues to be honored and upheld.

packages/textlint/README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,119 @@
11
# VS Code textlint extension
22

3-
Integrates [textlint](https://textlint.github.io/) into VS Code. If you are new to textlint check the [documentation](https://textlint.github.io/).
3+
Integrates [textlint](https://textlint.github.io/) into VS Code. If you are new to textlint, check the [documentation](https://textlint.github.io/).
44

55
![hover](https://github.com/textlint/vscode-textlint/raw/main/imgs/hover.png?raw=true)
66

77
![codeaction](https://github.com/textlint/vscode-textlint/raw/main/imgs/codeaction.png?raw=true)
88

9-
The extension uses the textlint library installed in the opened workspace folder. If the folder doesn't provide one the extension looks for a global install version. If you haven't installed textlint either locally or globally do so by running `npm install textlint` in the workspace folder for a local install or `npm install -g textlint` for a global install.
9+
The extension uses the textlint library installed in the opened workspace folder. If the folder doesn't provide one, the extension looks for a global install version. If you haven't installed textlint either locally or globally, you can do so by running `npm install textlint` in the workspace folder for a local install or `npm install -g textlint` for a global install.
1010

11-
On new folders you might also need to create a `.textlintrc` configuration file. You can do this by either running [`textlint --init`](https://github.com/textlint/textlint/blob/master/docs/getting-started.md#configuration) in a terminal or by using the VS Code command `Create '.textlintrc' file`.
11+
When working with new projects, you might need to create a `.textlintrc` configuration file. You can do this by either running [`textlint --init`](https://github.com/textlint/textlint/blob/master/docs/getting-started.md#configuration) in a terminal or by using the VS Code command `Create '.textlintrc' file`.
1212

13-
## Settings Options
13+
## Settings options
1414

1515
- `textlint.autoFixOnSave`
16-
- by default is `false`. if you set `true`, Automatically fix auto-fixable errors on save.
16+
- Default: `false`. When set to `true`, the extension will automatically fix auto-fixable errors on save.
1717
- `textlint.run`
18-
- run the linter `onSave` or `onType`, default is `onType`.
18+
- Controls when the linter runs. Options: `onSave` or `onType`. Default: `onType`.
1919
- `textlint.nodePath`
20-
- use this setting if an installed textlint package can't be detected, for example `/myGlobalNodePackages/node_modules`.
20+
- Use this setting if an installed textlint package can't be detected, for example `/myGlobalNodePackages/node_modules`.
2121
- `textlint.trace`
2222
- Traces the communication between VS Code and the textlint linter service.
2323
- `textlint.configPath`
24-
- absolute path to textlint config file.
25-
- workspace settings are prioritize.
24+
- Absolute path to textlint config file.
25+
- Workspace settings take priority over this setting.
2626
- `textlint.ignorePath`
27-
- absolute path to textlint ignore file.
28-
- see [here](https://textlint.github.io/docs/ignore.html#ignoring-files-textlintignore) for ignore file.
27+
- Absolute path to textlint ignore file.
28+
- See [here](https://textlint.github.io/docs/ignore.html#ignoring-files-textlintignore) for more information about ignore files.
2929
- `textlint.targetPath`
30-
- set a glob pattern.
30+
- Set a glob pattern to determine which files to lint.
3131
- `textlint.languages`
3232
- Languages to lint with textlint.
3333

3434
## Commands
3535

36-
This extension contributes the following commands to the Command palette.
36+
This extension contributes the following commands to the Command palette:
3737

3838
- Create '.textlintrc' File
39-
- Creates a new `.textlintrc` file.
39+
- Creates a new `.textlintrc` configuration file in your workspace.
4040
- Fix all auto-fixable Problems
41-
- Applies textlint auto-fix resolutions to all fixable problems.
41+
- Applies textlint auto-fix resolutions to all fixable problems in the current document.
4242

43-
## Release Notes
43+
## Release notes
4444

4545
### 0.12.0
4646

47-
- Change notification level from `ERROR` to `WARN` when executable file is not found ([#6](https://github.com/textlint/vscode-textlint/pull/6))
47+
- Changed notification level from `ERROR` to `WARN` when executable file is not found ([#6](https://github.com/textlint/vscode-textlint/pull/6))
4848
- Thanks to @azu
49-
- Improve `.textlintignore` support using `linter.scanFilePath()` API ([#7](https://github.com/textlint/vscode-textlint/pull/7))
49+
- Improved `.textlintignore` support using `linter.scanFilePath()` API ([#7](https://github.com/textlint/vscode-textlint/pull/7))
5050
- Thanks to @frozenbonito
51-
- Enable to emit activation events on all language files ([#8](https://github.com/textlint/vscode-textlint/pull/8))
51+
- Enabled to emit activation events on all language files ([#8](https://github.com/textlint/vscode-textlint/pull/8))
5252
- Thanks to @iku12phycho
5353

5454
### 0.11.0
5555

56-
- Fix highlight range issue
56+
- Fixed highlight range issue
5757
- Thanks to @Yuiki
5858

5959
### 0.10.0
6060

61-
- Add VS Code workspace support
62-
- Prepare for web-extension
61+
- Added VS Code workspace support
62+
- Prepared for web-extension
6363

6464
### 0.9.0
6565

66-
- Add `.textlintignore` support
66+
- Added `.textlintignore` support
6767
- Thanks to @frozenbonito
6868

6969
### 0.8.0
7070

71-
- Add option to choose languages and improve positioning of highlighted
71+
- Added option to choose languages and improved positioning of highlighted text
7272
- Thanks to @linhtto
7373

7474
### 0.7.0
7575

76-
- Add sets a target path support
76+
- Added target path support
7777
- Thanks to @bells17
7878

7979
### 0.6.8
8080

81-
- Change default value of `textlint.run` to `onSave`
82-
- Run tests on Azure Pipelines
81+
- Changed default value of `textlint.run` to `onSave`
82+
- Added Azure Pipelines for CI testing
8383

8484
### 0.6.5
8585

86-
- Add tex file support including `.tex`, `.latex`, `.doctex`
86+
- Added tex file support including `.tex`, `.latex`, `.doctex`
8787
- This feature works with [LaTeX Workshop](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) and [textlint-plugin-latex2e](https://github.com/ta2gch/textlint-plugin-latex2e)
8888

8989
### 0.5.0
9090

91-
- Add `configPath` to configuration. Recommend to use your user settings
91+
- Added `configPath` to configuration. Recommend to use your user settings
9292

9393
### 0.4.0
9494

95-
- Read configuration file from `HOME` dir
95+
- Added ability to read configuration file from `HOME` directory
9696
- If you want to use global configuration, you should install textlint and plugins globally
9797

9898
### 0.3.0
9999

100-
- Update runtime dependencies
100+
- Updated runtime dependencies
101101

102102
### 0.2.3
103103

104-
- Add tracing option
104+
- Added a tracing option
105105

106106
### 0.2.2
107107

108-
- Fix some bug
108+
- Fixed various bugs
109109

110110
### 0.2.1
111111

112-
- Add progress notification to StatusBar
112+
- Added progress notification to StatusBar
113113

114114
### 0.2.0
115115

116-
- Add support for fixing errors
116+
- Added support for fixing errors
117117

118118
### 0.1.0
119119

0 commit comments

Comments
 (0)