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

Commit 2ec5d93

Browse files
committed
update readme
1 parent ce4c6cb commit 2ec5d93

File tree

4 files changed

+45
-3
lines changed

4 files changed

+45
-3
lines changed

extension/README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,57 @@
22

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

5-
![](./assets/staturbar.png)
5+
## Getting Started
6+
7+
You need to configure which files should be checked with Grammarly.
8+
9+
- Set `grammarly.files.include` or **Grammarly > Files > Include** to the allowed list of files.
10+
- Run `grammarly.check` or **Grammarly: Check text** command
11+
12+
Default configuration:
13+
14+
```json
15+
{
16+
"grammarly.files.include": ["**/README.md", "**/readme.md", "**/*.txt"]
17+
}
18+
```
19+
20+
You may use `grammarly.files.exclude` to ignore specific files.
21+
22+
## Grammarly account or premium
23+
24+
Run `grammarly.login` or **Grammarly: Login / Connect your account** command to connect your Grammarly account.
25+
Run `grammarly.logout` or **Grammarly: Log out** to disconnect your account.
26+
27+
## Configuration
28+
29+
Configure dialect, document domain, and which check to include in settings.
630

7-
The status of the Grammarly text-checking session is displayed on the status bar (bottom right).
31+
![](./assets/screenshot-config.png)
32+
33+
## Supported Languages
34+
35+
- plaintext
36+
- markdown (work in progress) — [CommonMark](https://commonmark.org/)
37+
- html (work in progress)
38+
39+
## Troubleshooting
40+
41+
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.
42+
43+
![](./assets/staturbar.png)
844

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

50+
Check output panel for logs.
51+
52+
![](./assets/screenshot-output-panel.png)
53+
54+
Run `grammarly.restart` or **Grammarly: Restart language server** to restart the text checking service.
55+
1456
## How to get help
1557

1658
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.
3.01 MB
Loading
1.3 MB
Loading

extension/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@
340340
"enablement": "!grammarly.isActive"
341341
},
342342
{
343-
"title": "Log in / Connect your account",
343+
"title": "Login / Connect your account",
344344
"category": "Grammarly",
345345
"command": "grammarly.login",
346346
"icon": "$(log-in)",

0 commit comments

Comments
 (0)