After writing up a brief description, we recommend including the following sections.
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
Include if your extension adds any VS Code settings through the contributes.configuration extension point.
For example:
This extension contributes the following settings:
myExtension.enable: Enable/disable this extension.myExtension.thing: Set toblahto do something.
TBD
TBD
This project follows the best practices defined in the Visual Studio Code extension guidelines
- Reduce the extension size and improve the startup time by bundling your extension.
- Publish your extension on the VS Code extension marketplace.
- Automate builds by setting up Continuous Integration.