vbatts/vscode-next-note
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

README: updates

Browse source
This commit is contained in:
Vincent Batts 2017-02-20 12:32:01 -05:00
parent 7ed5420e13
commit 604dafb310
1 changed files with 4 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
README.md
View file

@ -1,65 +1,10 @@
# next-note README
This is the README for your extension "next-note". After writing up a brief description, we recommend including the following sections.
Helper for daily note taking
## Features
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
Provides a couple commands for inserting a heading of current timestamp
and for opening the current week's 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!**
If you have a global environment varaible of `NOTEDIR` set, then it will use this, otherwise defaults to `$HOME/Notes`.