Skip to content
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

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

Merged
merged 4 commits into from
Apr 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
],
"options": {
"printWidth": 80,
"proseWrap": "always"
"proseWrap": "preserve"
}
}
]
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Coder Remote

[![Visual Studio Marketplace](https://vsmarketplacebadges.dev/version/coder.coder-remote.svg)](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote)
[![Open VSX Version](https://img.shields.io/open-vsx/v/coder/coder-remote)](https://open-vsx.org/extension/coder/coder-remote)
[!["Join us on
Discord"](https://badgen.net/discord/online-members/coder)](https://coder.com/chat?utm_source=github.com/coder/vscode-coder&utm_medium=github&utm_campaign=readme.md)

Expand All @@ -13,11 +14,11 @@ workspaces with a single click.
- Works in air-gapped or restricted networks. Just connect to your Coder
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]
> The extension builds on VS Code-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 @@ -26,19 +27,18 @@ workspaces with a single click.
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press
enter.

```text
```shell
ext install coder.coder-remote
```

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