Skip to content

Commit 90d6a2a

Browse files
committed
doc: update.
1 parent 709ec4a commit 90d6a2a

File tree

1 file changed

+3
-23
lines changed

1 file changed

+3
-23
lines changed

README.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,10 @@
1-
# Cat Coding — A Webview API Sample
2-
3-
Demonstrates VS Code's [webview API](https://code.visualstudio.com/api/extension-guides/webview). This includes:
4-
5-
- Creating and showing a basic webview.
6-
- Dynamically updating a webview's content.
7-
- Loading local content in a webview.
8-
- Running scripts in a webview.
9-
- Sending message from an extension to a webview.
10-
- Sending messages from a webview to an extension.
11-
- Using a basic content security policy.
12-
- Webview lifecycle and handling dispose.
13-
- Saving and restoring state when the panel goes into the background.
14-
- Serialization and persistence across VS Code reboots.
15-
16-
## VS Code API
17-
18-
### `vscode` module
19-
20-
- [`window.createWebviewPanel`](https://code.visualstudio.com/api/references/vscode-api#window.createWebviewPanel)
21-
- [`window.registerWebviewPanelSerializer`](https://code.visualstudio.com/api/references/vscode-api#window.registerWebviewPanelSerializer)
1+
# Coding plugin for VS Code.
222

233
## Running the example
244

255
- Open this example in VS Code 1.47+
26-
- `npm install`
27-
- `npm run watch` or `npm run compile`
6+
- `yarn install`
7+
- `yarn watch` or `yarn compile`
288
- `F5` to start debugging
299

3010
Run the `Cat Coding: Start cat coding session` to create the webview.

0 commit comments

Comments
 (0)