Skip to content

Fix grammar and readability in README.md #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cyanzhong merged 2 commits into from
Mar 18, 2026
Merged

Fix grammar and readability in README.md #46

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23c49dc
Initial plan
Copilot Mar 18, 2026
dfb623e
docs: fix grammar issues and improve readability in README.md
Copilot Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Installation

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:
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:

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

## Configuration

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:
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:

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

- `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)
- `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
- `lintPreset`: `"strict"` (default), `"standard"`, or `"relaxed"`
- `lintRuleOverrides`: Per-rule overrides (`true` / `false` / `null`) applied on top of the preset
- `disabledLintKinds`: Additional lint kinds to filter out, available kinds:
- `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).
- `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.
- `lintPreset`: `"strict"` (default), `"standard"`, or `"relaxed"`.
- `lintRuleOverrides`: Per-rule overrides (`true` / `false` / `null`) applied on top of the preset.
- `disabledLintKinds`: Additional lint kinds to filter out. Available kinds:
- `Agreement`, `BoundaryError`, `Capitalization`, `Eggcorn`, `Enhancement`
- `Formatting`, `Grammar`, `Malapropism`, `Miscellaneous`, `Nonstandard`
- `Punctuation`, `Readability`, `Redundancy`, `Regionalism`, `Repetition`
Expand All @@ -56,7 +56,7 @@ https://writewithharper.com/docs/rules

## Dictionary

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.
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.

## Development

Expand Down