8000 chore(README.md): fix formatting and add OpenVSX badge by matifali · Pull Request #458 · coder/vscode-coder · GitHub
[go: up one dir, main page]

Skip to content

chore(README.md): fix formatting and add OpenVSX badge #458

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.

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
merged 4 commits into from
Apr 1, 2025
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
lint
  • Loading branch information
matifali committed Mar 28, 2025
commit e09bd77804f636d0cc0331624eb19947ed2cb7e1
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@
deployment!
- Supports multiple editors: VS Code, Cursor, and Windsurf.

> [!NOTE]
> The extension builds on VSCode provided implementations of SSH. Make sure
> you have the correct ssh extension installed for your editor
> (ms-vscode-remote.remote-ssh or codeium.windsurf-remote-openssh for
> windsurf)
> [!NOTE]

Check failure on line 18 in README.md

View workflow job for this annotation

GitHub Actions / lint

Replace `⏎>·The·extension·builds·on·VSCode·provided·implementations·of·SSH.·Make·sure·you⏎>` with `·The·extension·builds·on·VSCode·provided·implementations·of·SSH.·Make⏎>·sure·you`
> The extension builds on VSCode provided implementations of SSH. Make sure you
> have the correct ssh extension installed for your editor
> (ms-vscode-remote.remote-ssh or codeium.windsurf-remote-openssh for windsurf)

![Demo](https://github.com/coder/vscode-coder/raw/main/demo.gif?raw=true)

Expand All @@ -35,12 +34,11 @@
Alternatively, manually install the VSIX from the
[latest release](https://github.com/coder/vscode-coder/releases/latest).

#### Variables Reference
### Variables Reference

Coder uses
`${userHome}` from VS Code's
Coder uses `${userHome}` from VS Code's
[variables reference](https://code.visualstudio.com/docs/editor/variables-reference).
Use this when formatting paths in the Coder extension settings rather than `~` or
`$HOME`.
Use this when formatting paths in the Coder extension settings rather than `~`
or `$HOME`.

Example: ${userHome}/foo/bar.baz
Loading
0