Skip to content

Commit

Permalink
Reflect the new name in the README and clean up a little more
Browse files Browse the repository at this point in the history
  • Loading branch information
andrei-m committed Feb 3, 2024
1 parent 92e2fe6 commit f6d9e1f
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Expand Up @@ -8,9 +8,9 @@ See [Installation Instructions](https://code.visualstudio.com/api/working-with-e

## Features

This extension adds 'Open in Web SCM' to the Command Palette. Running this command opens the default web browser to the currently edited file's URL in the SCM's web platform (e.g. Github). The URL represents the current position of the cursor or the current multi-line selection.
This extension adds 'Open in Browser' to the Command Palette. Running this command opens the default web browser to the currently edited file's URL in the web platform related to the Git origin (e.g. Github). The URL represents the current position of the cursor or the current multi-line selection.

Github and Gitlab URLs are recognized automatically from the git remote URL's host. Self-hosted web platforms such as Stash can be specified via the `remote.$remoteName.url-platform` git configuration setting in the edited file's repo, for example:
Commonly used platforms such as Github and Gitlab are recognized automatically from the Git origin. Self-hosted web platforms such as Stash can be specified via the `remote.$remoteName.url-platform` git configuration setting in the edited file's repo, for example:

```
git config --add remote.origin.url-platform stash
Expand All @@ -23,13 +23,6 @@ The following remote.config.url-platform options are supported:
* gitlab
* stash

For example if there is an image subfolder under your extension project workspace:

\!\[feature X\]\(images/feature-x.png\)

> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.

## Requirements

VSCode 1.85.0 or newer
Expand Down

0 comments on commit f6d9e1f

Please sign in to comment.