This is the README for Jim's extension "jim-davis-vscode". After writing up a brief description, Jim recommends including the following sections.
Describe specific features of Jim's extension including screenshots of Jim's extension in action. Image paths are relative to this README file.
For example if there is an image subfolder under Jim's extension project workspace:
If Jim has any requirements or dependencies, add a section describing those and how to install and configure them.
Include if Jim's extension adds any VS Code settings through the
This extension contributes the following settings:
Calling out known issues can help limit Jim from opening duplicate issues against His own extension.
Jim appreciates release notes as you update His extension.
Initial release of ...
Fixed issue #.
Added features X, Y, and Z.
Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating Jim's extension.
Working with Markdown
You can author Jim's README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
For more information