Skip to content

Commit 82e4002

Browse files
authored
Update README (#1793)
* update readme text * add more resources link
1 parent c54dd76 commit 82e4002

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# VS Code DVC: Insider Preview
1+
# DVC Extension for Visual Studio Code
22

33
<!--- These will be broken until the repo is public --->
44
<!--- [![Continuous Integration](https://github.com/iterative/vscode-dvc/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/iterative/vscode-dvc/actions/workflows/continuous-integration.yml) --->
@@ -14,21 +14,31 @@ users of all technical backgrounds to effectively use [DVC](https://dvc.org/).
1414

1515
## Current State
1616

17-
This project is currently in closed alpha testing, and constantly evolving.
18-
After we conclude alpha and beta testing the repository will become public.
17+
We want early adopter feedback! Please let us know what you like and don't like
18+
about the extension. Feel free to reach out in this repository's
19+
[issues](https://github.com/iterative/vscode-dvc/issues) or via any of the other
20+
existing [support channels](https://dvc.org/support).
1921

2022
## Quick Start
2123

2224
- **Step 1.**
2325
[Install a supported version of DVC on your system](https://dvc.org/doc/install)
2426
- **Step 2.**
2527
[Install the DVC extension for Visual Studio Code](https://code.visualstudio.com/docs/editor/extension-gallery).
26-
- **Step 3.** See walkthrough.
28+
- **Step 3.** See Walkthrough.
2729

28-
**Note:** You will be prompted to open our walkthrough after installation. If
29-
for any reason you need to revisit the walkthrough, open the Command Palette
30-
(⇧⌃P on Windows/Linux or ⇧⌘P on macOS) and select the `DVC: Get Started`
31-
command.
30+
## Useful commands
31+
32+
Open the Command Palette (`F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS) and type
33+
in one of the following commands:
34+
35+
| Command | Description |
36+
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
37+
| `DVC: Get Started` | Open the extension's walkthrough. Which details all of the current features and provides links to extra learning resources. |
38+
| `View: Show DVC` | Open the extension's view container. |
39+
| `DVC: Setup The Workspace` | Activate the extension's workspace setup wizard. |
40+
| `DVC: Show Experiments` | Show an interactive version of DVC's `exp show` [command](https://dvc.org/doc/command-reference/exp/show). |
41+
| `DVC: Show Plots` | Show an interactive version of DVC's `plots diff` [command](https://dvc.org/doc/command-reference/plots/diff). |
3242

3343
## Features
3444

@@ -51,6 +61,10 @@ pipelines, and most scripts are capable of running outside of DVC.
5161
See development docs and contributing guidelines in
5262
[CONTRIBUTING.md](CONTRIBUTING.md)
5363

64+
## Explore
65+
66+
View [more resources](extension/resources/walkthrough/dvc-learn-more.md).
67+
5468
## Data and telemetry
5569

5670
The DVC Extension for Visual Studio Code collects usage data and sends it to

extension/resources/walkthrough/command-palette.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This extension makes extensive use of the
44
[Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
5-
Which can be accessed via ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
5+
Which can be accessed via `F1` or ⇧⌃P on Windows/Linux or ⇧⌘P on macOS.
66

77
To see a list of available commands click [here](command:dvc.showCommands) or
88
type DVC into the Command Palette.

0 commit comments

Comments
 (0)