feat(vscode-plugin): added installation instructions

Automattic · Oct 11, 2024 · 6040784 · 6040784
1 parent cc58412
commit 6040784
Showing 1 changed file with 12 additions and 20 deletions.
diff --git a/packages/vscode-plugin/README.md b/packages/vscode-plugin/README.md
@@ -1,10 +1,16 @@
 # Harper for VS Code
 
-Harper is the grammar checker for developers. It checks for spelling and grammar errors in your Markdown files and code comments. You can find out more by checking the [project's readme](/README.md) or by visiting the [website](https://writewithharper.com).
+Harper is the grammar checker for developers. It checks for spelling and grammar errors in your Markdown files and code comments. You can find out more by checking it out on [GitHub](https://github.com/elijah-potter/harper) or by visiting the [website](https://writewithharper.com).
 
 ## Installation
 
-## Features
+Installation should be relatively straightforward.
+It just depends on which editor and marketplace you're using.
+
+If you use the official Microsoft Visual Studio Code release, go ahead and go to the marketplace and search for "Harper" and click "Install".
+You can also visit our [official page](https://marketplace.visualstudio.com/items?itemName=elijah-potter.harper&ssr=false#overview).
+
+If you use OpenVSX, for instance if you use VSCodium, you'll want to install from [here](https://open-vsx.org/extension/elijah-potter/harper).
 
 ### Commands
 
@@ -14,24 +20,10 @@ Harper is the grammar checker for developers. It checks for spelling and grammar
 
 ### Settings
 
-| Setting                                          | Possible Values                                   | Default Value   | Description                                                                |
-| ------------------------------------------------ | ------------------------------------------------- | --------------- | -------------------------------------------------------------------------- |
-| `harper-ls.linters.spell_check`                  | `true`, `false`                                   | `true`          | Detect and provide suggestions for misspelled words.                       |
-| `harper-ls.linters.spelled_numbers`              | `true`, `false`                                   | `false`         | Detect and fix instances where small numbers should be spelled out.        |
-| `harper-ls.linters.an_a`                         | `true`, `false`                                   | `true`          | Detect and fix improper articles.                                          |
-| `harper-ls.linters.sentence_capitalization`      | `true`, `false`                                   | `true`          | Ensure your sentences are capitalized.                                     |
-| `harper-ls.linters.unclosed_quotes`              | `true`, `false`                                   | `true`          | Make sure you close your quotation marks.                                  |
-| `harper-ls.linters.wrong_quotes`                 | `true`, `false`                                   | `false`         | Make sure you use the correct unicode characters for your quotation marks. |
-| `harper-ls.linters.long_sentences`               | `true`, `false`                                   | `true`          | Warn about run-on sentences.                                               |
-| `harper-ls.linters.repeated_words`               | `true`, `false`                                   | `true`          | Detect and fix commonly repeated words.                                    |
-| `harper-ls.linters.spaces`                       | `true`, `false`                                   | `true`          | Detect improper spacing between words.                                     |
-| `harper-ls.linters.matcher`                      | `true`, `false`                                   | `true`          | A collection of hand-crafted common grammar mistakes.                      |
-| `harper-ls.linters.correct_number_suffix`        | `true`, `false`                                   | `true`          | Make sure you provide the correct suffix for numbers.                      |
-| `harper-ls.linters.number_suffix_capitalization` | `true`, `false`                                   | `true`          | Make sure you correctly capitalize your number suffixes.                   |
-| `harper-ls.linters.multiple_sequential_pronouns` | `true`, `false`                                   | `true`          | Detect improper sequences of pronouns.                                     |
-| `harper-ls.linters.linking_verbs`                | `true`, `false`                                   | `true`          | Detect improper use of linking verbs.                                      |
-| `harper-ls.linters.avoid_curses`                 | `true`, `false`                                   | `true`          | Catch use of curse/swear words.                                            |
-| `harper-ls.diagnosticSeverity`                   | `"error"`, `"hint"`, `"information"`, `"warning"` | `"information"` | How severe do you want diagnostics to appear in the editor?                |
+| Setting                        | Possible Values                                   | Default Value   | Description                                                       |
+| ------------------------------ | ------------------------------------------------- | --------------- | ----------------------------------------------------------------- |
+| `harper-ls.linters.*`          | `true`, `false`                                   | Varies          | Detect and provide suggestions in a variety of common situations. |
+| `harper-ls.diagnosticSeverity` | `"error"`, `"hint"`, `"information"`, `"warning"` | `"information"` | How severe do you want diagnostics to appear in the editor?       |
 
 ## Developing and Contributing