Skip to content
This repository was archived by the owner on Jan 6, 2025. It is now read-only.

Commit b0ed7ef

Browse files
Update readme and getting started guide (#367)
Description of changes Includes updates to the project `README` and getting started guide based on an internal string review.
1 parent 3ba7054 commit b0ed7ef

File tree

2 files changed

+52
-54
lines changed

2 files changed

+52
-54
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@
1212

1313
The Webview UI Toolkit is a component library for building [webview-based extensions](https://code.visualstudio.com/api/extension-guides/webview) in Visual Studio Code.
1414

15-
Features of the library include:
15+
Some of the library's features include:
1616

17-
- **Implements the Visual Studio Code design language:** All components follow the design language of Visual Studio Code – enabling developers to create extensions that have a consistent look and feel with the rest of the editor.
18-
- **Automatic support for color themes:** All components are designed with theming in mind and will automatically display the current editor theme.
19-
- **Use any tech stack:** The library ships as a set of web components, meaning developers can use the toolkit no matter what tech stack (React, Vue, Svelte, etc.) their extension is built with.
20-
- **Accessible out of the box:** All components ship with web standard compliant ARIA labels and keyboard navigation.
17+
- **Visual Studio Code design language:** All components follow the design language of Visual Studio Code, which enables developers to create extensions that have a consistent look and feel with the rest of the editor.
18+
- **Automatic support for color themes:** All components are designed with theming in mind, and will automatically display the current editor theme.
19+
- **Tech stacks:** The library ships as a set of web components. This means developers can use the toolkit no matter which tech stack React, Vue, Svelte, etc. their extension is built with.
20+
- **Immediate accessibility:** All components ship with web-standard compliant ARIA labels and keyboard navigation.
2121

2222
## Getting started
2323

@@ -31,7 +31,7 @@ npm install --save @vscode/webview-ui-toolkit
3131

3232
## Documentation
3333

34-
Further documentation can be found in the following places:
34+
For more information, check out the following documentation:
3535

3636
- [Component Docs](./docs/components.md)
3737
- [Toolkit Extension Samples](https://github.com/microsoft/vscode-webview-ui-toolkit-samples)
@@ -43,23 +43,23 @@ Further documentation can be found in the following places:
4343

4444
## A note on webview usage
4545

46-
Webviews are a powerful way to add custom functionality that is beyond what the VS Code API supports. They are fully customizable, which has historically meant that the responsibility of developing UI that aligns with the VS Code design language and follows our [webview guidelines](https://code.visualstudio.com/api/references/extension-guidelines#webviews) lies in the hands of extension authors.
46+
Webviews are a powerful way to add custom functionality beyond what the Visual Studio Code API supports. They're fully customizable, which, historically, has meant that the responsibility of developing UI which aligns with the Visual Studio Code design language and follows our [webview guidelines](https://code.visualstudio.com/api/references/extension-guidelines#webviews) lies in the hands of extension authors.
4747

48-
The Webview UI Toolkit shifts _some_ of this responsibility away from extension developers by providing core components that make it easier to build higher quality webview UIs in VS Code.
48+
The Webview UI Toolkit shifts _some_ of this responsibility away from extension developers. It does this by providing core components that make it easier to build higher quality webview UIs in Visual Studio Code.
4949

50-
With all this said, we still strongly encourage a careful review of whether your extension needs to use webviews or not before building. While webviews provide a great way to add custom functionality it often comes at the cost of performance and accessibility.
50+
With all this said, we still strongly encourage you to carefully review whether or not your extension needs to use webviews before building. While webviews provide a great way to add custom functionality, oftentimes, they come at the cost of performance and accessibility.
5151

52-
The core VS Code API provides a vast array of building blocks for highly performant, accessible, and tighly integrated extension experiences and we will generally encourage their usage before webviews. If you haven't already, feel free to check out this [overview of API capabilities](https://code.visualstudio.com/api/extension-capabilities/overview) to get an idea of what's possible.
52+
The core Visual Studio Code API provides a vast array of building blocks for highly performant, accessible, and tightly integrated extension experiences. Generally, we encourage you to use them before webviews. If you haven't already, check out this [overview of API capabilities](https://code.visualstudio.com/api/extension-capabilities/overview) to get an idea of what's possible.
5353

54-
Finally, if you are ever unsure if your extension should make use of webviews or not, please open an issue and we would be more than happy to give some feedback and guidance.
54+
Finally, if you're ever unsure if your extension should use webviews or not, you should open an issue and we'll give you some feedback and guidance.
5555

5656
## Release
5757

5858
The Webview UI Toolkit is currently in a public preview with the goal of reaching `v1.0` sometime in Winter 2022.
5959

6060
## Contributing
6161

62-
See the [contributing](./CONTRIBUTING.md) documentation.
62+
Read the [contributing](./CONTRIBUTING.md) documentation.
6363

6464
## Legal notices
6565

0 commit comments

Comments
 (0)