Skip to content

Commit

Permalink
update readme for clarity.
Browse files Browse the repository at this point in the history
  • Loading branch information
tpeacock19 committed Mar 2, 2024
1 parent 8c7f97e commit 9f12800
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,27 @@ The instruction to use this plugin.

3. :tada: Done! Now open a text file and hit `M-x flymake-mode`!

otherwise you can call `flymake-languagetool-maybe-load` like the snippet below.
Another option is to add `flymake-languagetool-maybe-load` to
`find-file-hook`, this way `flymake-languagetool` will be enabled
whenever `flymake-mode` is active and the current major-mode is
included in `flymake-languagetool-active-modes`.

```el
(add-hook 'find-file-hook 'flymake-languagetool-maybe-load)
```

## 🧪 Configuration

- `flymake-languagetool-server-jar`
- `flymake-languagetool-active-modes`
- `flymake-languagetool-check-spelling`
- `flymake-languagetool-language` (Default `"en-US"`)
### Language
The language used for flymake can be customized by using
`flymake-languagetool-language` (Default `"en-US"`)

### Active Modes

If you are using `flymake-languagetool-maybe-load` you can customize
which modes `flymake-languagetool` will be enabled for by adding a
major-mode to `flymake-languagetool-active-modes`. The default value
is `'(text-mode latex-mode org-mode markdown-mode message-mode)`

### Spellchecking

Expand Down

0 comments on commit 9f12800

Please sign in to comment.