Skip to content

Commit 78db116

Browse files
Copilotcyanzhong
andauthored
Fix grammar and readability in README.md (#46)
* Initial plan * docs: fix grammar issues and improve readability in README.md Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>
1 parent 588f262 commit 78db116

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
## Installation
1010

11-
This extension is very big (24 MB) because it runs completely locally, install it by downloading `markedit-proofreading.js` from the [latest release](https://github.com/MarkEdit-app/MarkEdit-proofreading/releases/latest) and copying it to:
11+
This extension is large (24 MB) because it runs completely locally. Install it by downloading `markedit-proofreading.js` from the [latest release](https://github.com/MarkEdit-app/MarkEdit-proofreading/releases/latest) and copying it to:
1212

1313
```
1414
~/Library/Containers/app.cyan.markedit/Data/Documents/scripts
@@ -18,7 +18,7 @@ Restart MarkEdit after copying the file.
1818

1919
## Configuration
2020

21-
This extension provides three presets to control how aggressively Harper checks your writing. Presets disable specific [rules](https://writewithharper.com/docs/rules) via [`setLintConfig`](https://writewithharper.com/docs/harperjs/configurerules) and filter by lint kind as a safety net:
21+
This extension provides three presets to control how aggressively Harper checks your writing. Each preset disables specific [rules](https://writewithharper.com/docs/rules) via [`setLintConfig`](https://writewithharper.com/docs/harperjs/configurerules) and filters by lint kind as a safety net:
2222

2323
- `"strict"` (default): All Harper rules are active
2424
- `"standard"`: Disables Enhancement, Style, and WordChoice rules
@@ -41,11 +41,11 @@ You can customize behavior from `settings.json` with the `extension.markeditProo
4141
}
4242
```
4343

44-
- `autoLintDelay`: Delay in milliseconds before automatic proofreading runs after a document change (default: `1000`). Set to `-1` to disable automatic proofreading entirely (use "Proofread Now" to lint on demand)
45-
- `addToDict`: When `true` (default), clicking "Ignore" on a flagged word also adds it to a personal dictionary so it won't be flagged in future sessions. Set to `false` to disable this behavior
46-
- `lintPreset`: `"strict"` (default), `"standard"`, or `"relaxed"`
47-
- `lintRuleOverrides`: Per-rule overrides (`true` / `false` / `null`) applied on top of the preset
48-
- `disabledLintKinds`: Additional lint kinds to filter out, available kinds:
44+
- `autoLintDelay`: Delay in milliseconds before automatic proofreading runs after a document change (default: `1000`). Set to `-1` to disable automatic proofreading entirely (use "Proofread Now" to lint on demand).
45+
- `addToDict`: When `true` (default), clicking "Ignore" on a flagged word also adds it to a personal dictionary so it won't be flagged in future sessions. Set to `false` to disable this behavior.
46+
- `lintPreset`: `"strict"` (default), `"standard"`, or `"relaxed"`.
47+
- `lintRuleOverrides`: Per-rule overrides (`true` / `false` / `null`) applied on top of the preset.
48+
- `disabledLintKinds`: Additional lint kinds to filter out. Available kinds:
4949
- `Agreement`, `BoundaryError`, `Capitalization`, `Eggcorn`, `Enhancement`
5050
- `Formatting`, `Grammar`, `Malapropism`, `Miscellaneous`, `Nonstandard`
5151
- `Punctuation`, `Readability`, `Redundancy`, `Regionalism`, `Repetition`
@@ -56,7 +56,7 @@ https://writewithharper.com/docs/rules
5656

5757
## Dictionary
5858

59-
When `addToDict` is enabled (default), clicking "Ignore" on a flagged word also adds it to a personal dictionary persisted at `~/Library/Containers/app.cyan.markedit/Data/Documents/proofreading-dict.txt`. Dictionary words are automatically loaded when the extension starts.
59+
When `addToDict` is enabled (default), clicking "Ignore" on a flagged word also adds it to a personal dictionary stored at `~/Library/Containers/app.cyan.markedit/Data/Documents/proofreading-dict.txt`. Dictionary words are automatically loaded when the extension starts.
6060

6161
## Development
6262

0 commit comments

Comments
 (0)