Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
znck committed May 14, 2022
1 parent ce4c6cb commit 2ec5d93
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 3 deletions.
46 changes: 44 additions & 2 deletions extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,57 @@

This extension brings [Grammarly](https://grammarly.com) to VS Code.

![](./assets/staturbar.png)
## Getting Started

You need to configure which files should be checked with Grammarly.

- Set `grammarly.files.include` or **Grammarly > Files > Include** to the allowed list of files.
- Run `grammarly.check` or **Grammarly: Check text** command

Default configuration:

```json
{
"grammarly.files.include": ["**/README.md", "**/readme.md", "**/*.txt"]
}
```

You may use `grammarly.files.exclude` to ignore specific files.

## Grammarly account or premium

Run `grammarly.login` or **Grammarly: Login / Connect your account** command to connect your Grammarly account.
Run `grammarly.logout` or **Grammarly: Log out** to disconnect your account.

## Configuration

Configure dialect, document domain, and which check to include in settings.

The status of the Grammarly text-checking session is displayed on the status bar (bottom right).
![](./assets/screenshot-config.png)

## Supported Languages

- plaintext
- markdown (work in progress) — [CommonMark](https://commonmark.org/)
- html (work in progress)

## Troubleshooting

The status of the Grammarly text-checking session is displayed on the status bar (bottom right). Clicking on the status bar icon would pause/resume text checking session.

![](./assets/staturbar.png)

| Session | Connecting | Checking | Done | Paused | Error |
| ----------------- | ----------------------------------- | --------------------------------- | ---------------------------------- | ------------------------------- | ------------------------------ |
| Anonymous | ![](./assets/status-connecting.png) | ![](./assets/status-checking.png) | ![](./assets/status-done.png) | ![](./assets/status-paused.png) | ![](./assets/status-error.png) |
| Grammarly Account | ![](./assets/status-connecting.png) | ![](./assets/status-checking.png) | ![](./assets/status-connected.png) | ![](./assets/status-paused.png) | ![](./assets/status-error.png) |

Check output panel for logs.

![](./assets/screenshot-output-panel.png)

Run `grammarly.restart` or **Grammarly: Restart language server** to restart the text checking service.

## How to get help

Have a question, or want to provide feedback? Use [repository discussions](https://github.com/znck/grammarly/discussions) to ask questions, share bugs or feedback, or chat with other users.
Expand Down
Binary file added extension/assets/screenshot-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added extension/assets/screenshot-output-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@
"enablement": "!grammarly.isActive"
},
{
"title": "Log in / Connect your account",
"title": "Login / Connect your account",
"category": "Grammarly",
"command": "grammarly.login",
"icon": "$(log-in)",
Expand Down

0 comments on commit 2ec5d93

Please sign in to comment.