diff options
author | Indrajith K L | 2017-09-20 15:00:44 +0530 |
---|---|---|
committer | Indrajith K L | 2017-09-20 15:00:44 +0530 |
commit | fa707962d8bd220b611f6f5f29cba11ca7e67a92 (patch) | |
tree | bc3bfe79d95ae4fe1847991c993472209528edcb /README.md | |
download | KopyPlugin-fa707962d8bd220b611f6f5f29cba11ca7e67a92.tar.gz KopyPlugin-fa707962d8bd220b611f6f5f29cba11ca7e67a92.tar.bz2 KopyPlugin-fa707962d8bd220b611f6f5f29cba11ca7e67a92.zip |
Initial Commit
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b2b60f8 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# kopy-io-plugin README + +This is the README for your extension "kopy-io-plugin". After writing up a brief description, we recommend including the following sections. + +## Features + +Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. + +For example if there is an image subfolder under your extension project workspace: + +\!\[feature X\]\(images/feature-x.png\) + +> 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. + +## Requirements + +If you have any requirements or dependencies, add a section describing those and how to install and configure them. + +## Extension Settings + +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 to `blah` to do something + +## Known Issues + +Calling out known issues can help limit users opening duplicate issues against your extension. + +## Release Notes + +Users appreciate release notes as you update your extension. + +### 1.0.0 + +Initial release of ... + +### 1.0.1 + +Fixed issue #. + +### 1.1.0 + +Added features X, Y, and Z. + +----------------------------------------------------------------------------------------------------------- + +## Working with Markdown + +**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: + +* Split the editor (`Cmd+\` on OSX or `Ctrl+\` on Windows and Linux) +* Toggle preview (`Shift+CMD+V` on OSX or `Shift+Ctrl+V` on Windows and Linux) +* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (OSX) to see a list of Markdown snippets + +### For more information + +* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) +* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) + +**Enjoy!**
\ No newline at end of file |