Skip to content

Commit

Permalink
docs and friendlier command names
Browse files Browse the repository at this point in the history
  • Loading branch information
bradshjg authored Aug 8, 2021
1 parent c25fff7 commit fc5855d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,20 @@ VS Code extension to launch a server capable of handling client requests for [vi
The idea is that instead of requiring the user to install the dependencies (Node/Express/FS-Extra) and run it standalone, VS
Code can run it via the extension host (since it already has the Node runtime laying around for us :smile:).

## Features
## Installation

No user-facing features, yet! And maybe not ever!
Visit the "Releases" page in GitHub and download the latest ".vsix" extension.

In VS Code, use the command pallete (e.g. `Cmd+Shift+P`) to run "Extensions: Install from VSIX..." and install the
extension.

You'll need to visit the extensions tab in VS Code to "Install in Codespaces".

Once installed, use the command pallete to run "GitHub Desktop: Start virtual repo server".

Now you can add a virtual repo in GitHub Desktop.

Sigh...this should be easier.

## Requirements

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@
{
"command": "github-desktop-virtual-server.startServer",
"title": "Start virtual repo server",
"category": "GH Desktop"
"category": "GitHub Desktop"
},
{
"command": "github-desktop-virtual-server.stopServer",
"title": "Stop virtual repo server",
"category": "GH Desktop"
"category": "GitHub Desktop"
}
]
},
Expand Down

0 comments on commit fc5855d

Please sign in to comment.