diff --git a/README.md b/README.md index cede1227..55203ab7 100644 --- a/README.md +++ b/README.md @@ -2,28 +2,20 @@ VS Code Extension Samples -This repository contains sample code illustrating the VS Code extension API. Each sample is a self-contained extension that explains one topic. +This repository contains sample code illustrating the VS Code extension API. Each sample is a self-contained extension that explains one topic in [VS Code API](https://code.visualstudio.com/docs/extensionAPI/vscode-api) or VS Code's [Contribution Points](https://code.visualstudio.com/docs/extensionAPI/extension-points). You can read, play with or adapt from these samples to create your own extensions. -| Sample | Guide on VS Code Website | API | +Each sample is required to have: +- A explanation of its functionality +- A gif or screenshot demonstrating its usage +- Link to a guide on VS Code website, if it has one +- Listing of used VS Code API and Contribution Points + +## Samples + +| Sample | Guide on VS Code Website | API & Contribution | | ------ | ----- | --- | -| [Virtual Documents](/contentprovider-sample/README.md) | [/api/extension-guides/virtual-documents](/api/extension-guides/virtual-documents) | [`TextDocumentContentProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#TextDocumentContentProvider) | -| [Editor Decoration](/decorator-sample/README.md) | [/api/extension-guides/editor-decoration](/api/extension-guides/editor-decoration) | [`window.createTextEditorDecorationType`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.createTextEditorDecorationType) | -| [Status Bar](/status-bar) | [/api/extension-guides/status-bar](/api/extension-guides/status-bar) | [`StatusBarItem`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#StatusBarItem) | - -- [Virtual Documents](/contentprovider-sample/README.md) -- [Editor Decoration](/decorator-sample/README.md) -- [Status Bar](/statusbar-sample/README.md) -- [Theme](/theme-sample) -- [Integrated Terminal](/terminal-sample/README.md) -- [Vim](/vim-sample/README.md) -- [Tree views](/tree-view-sample/README.md) -- [Webview](/webview-sample/README.md) - -# ➡️ Getting Started - -You can get started locally by following these steps: - -- **Step #1**: `git clone https://github.com/Microsoft/vscode-extension-samples vscode-extension-samples` -- **Step #2**: `cd vscode-extension-samples` -- **Step #3**: `npm install` -- **Step #4**: Open [VSCode](https://code.visualstudio.com/) and start a sample from the debug viewlet. +| [Virtual Documents](/contentprovider-sample/README.md) | [/api/extension-guides/virtual-documents](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/virtual-documents) | [`TextDocumentContentProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#TextDocumentContentProvider)| +| [Editor Decoration](/decorator-sample/README.md) | [/api/extension-guides/editor-decoration](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/editor-decoration) | [`window.createTextEditorDecorationType`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#window.createTextEditorDecorationType) | +| [Status Bar](/statusbar-sample/README.md) | [/api/extension-guides/status-bar](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/status-bar) | [`StatusBarItem`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#StatusBarItem) | +| [Color Theme](/theme-sample/README.md) | [/api/extension-guides/color-theme](https://vscode-ext-docs.azurewebsites.net/api/extension-guides/color-theme) | [`contributes.themes`](https://code.visualstudio.com/docs/extensionAPI/extension-points#_contributesthemes) | +| [File System Provider](/fsprovider-sample/README.md) | N/A | [`vscode.workspace.registerFileSystemProvider`](https://code.visualstudio.com/docs/extensionAPI/vscode-api#workspace.registerFileSystemProvider) | \ No newline at end of file