Skip to content

Commit 3e0f5b6

Browse files
Update readme (microsoft#75)
Description of changes Includes updates to the project README based on an internal string review.
1 parent aeb009a commit 3e0f5b6

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,67 +2,67 @@
22

33
This repository contains all the sample extensions for the [Webview UI Toolkit for Visual Studio Code](https://github.com/microsoft/vscode-webview-toolkit).
44

5-
Each sample is a self contained extension and demonstrates some aspect of the toolkit and/or the [VS Code API](https://code.visualstudio.com/api/references/vscode-api) in relation to the toolkit. You can read, play with, or adapt these samples to create your own extensions.
5+
Each sample is a self-contained extension, and demonstrates some aspect of the toolkit and/or the [Visual Studio Code API](https://code.visualstudio.com/api/references/vscode-api) in relation to the toolkit. You can read, play with, or adapt these samples to create your own extensions.
66

77
## Prerequisites
88

9-
You need to have [Node and NPM](https://nodejs.org/en/) installed on your system to run the samples. It is recommended to use the Node version used for VS Code development itself which is documented [here](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites).
9+
You need to have [Node and NPM](https://nodejs.org/en/) installed on your system to run the samples. We recommend you use the Node version used for Visual Studio Code development itself, which is documented [here](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#prerequisites).
1010

1111
## Usage
1212

1313
Follow the instructions in the `README` file of the desired sample extension.
1414

15-
### Default Samples
15+
### Default samples
1616

17-
A set of sample extensions using vanilla HTML, CSS, and JavaScript to render the Webview UI.
17+
A set of sample extensions using vanilla HTML, CSS, and JavaScript to render the webview UI.
1818

19-
| Sample Extension | Description |
19+
| Sample extension | Description |
2020
| ------------------------------------------------ | --------------------------------------------------------------------------------- |
2121
| [component-gallery](./default/component-gallery) | Demonstrates every component in the Webview UI Toolkit. |
22-
| [hello-world](./default/hello-world) | A basic hello world starter extension. |
23-
| [notepad](./default/notepad) | A simple note taking extension that leverages the VS Code TreeView API. |
24-
| [weather-webview](./default/weather-webview) | Demonstrates the toolkit being used within a Webview View (i.e. VS Code sidebar). |
22+
| [hello-world](./default/hello-world) | A basic hello-world starter extension. |
23+
| [notepad](./default/notepad) | A simple notetaking extension that leverages the VS Code TreeView API. |
24+
| [weather-webview](./default/weather-webview) | Demonstrates the toolkit being used within a webview view – i.e., Visual Studio Code sidebar. |
2525

26-
### React Samples
26+
### React samples
2727

28-
A set of sample extensions using React to render the Webview UI.
28+
A set of sample extensions using React to render the webview UI.
2929

30-
| Sample Extension | Description |
30+
| Sample extension | Description |
3131
| ---------------------------------------------| --------------------------------------------------------------------- |
32-
| [hello-world-cra](./react/hello-world-cra) | A basic hello world starter extension using React + Create React App. |
33-
| [hello-world-vite](./react/hello-world-vite) | A basic hello world starter extension using React + Vite. |
32+
| [hello-world-cra](./react/hello-world-cra) | A basic hello-world starter extension using React + Create React App. |
33+
| [hello-world-vite](./react/hello-world-vite) | A basic hello-world starter extension using React + Vite. |
3434

35-
### Svelte Samples
35+
### Svelte samples
3636

37-
A set of sample extensions using Svelte to render the Webview UI.
37+
A set of sample extensions using Svelte to render the webview UI.
3838

39-
| Sample Extension | Description |
40-
| ------------------------| ----------- |
41-
| _Coming in the future!_ | |
39+
| Sample extension | Description |
40+
| -----------------| ----------- |
41+
| _Coming soon_ | |
4242

43-
### Vue Samples
43+
### Vue samples
4444

45-
A set of sample extensions using Vue to render the Webview UI.
45+
A set of sample extensions using Vue to render the webview UI.
4646

47-
| Sample Extension | Description |
48-
| ------------------------| ----------- |
49-
| _Coming in the future!_ | |
47+
| Sample extension | Description |
48+
| -----------------| ----------- |
49+
| _Coming soon_ | |
5050

51-
### Angular Samples
51+
### Angular samples
5252

53-
A set of sample extensions using Angular to render the Webview UI.
53+
A set of sample extensions using Angular to render the webview UI.
5454

55-
| Sample Extension | Description |
56-
| ------------------------| ----------- |
57-
| _Coming in the future!_ | |
55+
| Sample extension | Description |
56+
| -----------------| ----------- |
57+
| _Coming soon_ | |
5858

59-
### Other Samples
59+
### Other samples
6060

61-
Don't see a demonstration for your desired framework, API, use case, and so on? Feel free to open an issue and request it!
61+
Don't see a demonstration for your desired framework, API, use case, etc.? Open an issue and request it.
6262

6363
## Contributing
6464

65-
See the [contributing](./CONTRIBUTING.md) documentation.
65+
Read the [contributing](./CONTRIBUTING.md) documentation.
6666

6767
## Legal notices
6868

0 commit comments

Comments
 (0)