Getting ready to release initial 1.0.0 version.

This commit is contained in:
Juha Ristolainen 2017-03-17 17:52:10 +00:00
parent 768f37d9e8
commit 3e6bbab84a
2 changed files with 8 additions and 44 deletions

View File

@ -1,65 +1,29 @@
# code-stats-vscode README # Code::Stats extension to Visual Studio Code.
This is the README for your extension "code-stats-vscode". After writing up a brief description, we recommend including the following sections. This is a Visual Studio Code extension to send updates to [https://codestats.net](https://codestats.net)
## Features ## Features
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. This extension tracks the amount of changes you make to your files and sends out pulses to [https://codestats.net/api-docs#pulse](https://codestats.net/api-docs#pulse) to track your XP.
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 ## Extension Settings
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. You need to register your machine at [https://codestats.net/my/machines](https://codestats.net/my/machines) to get an API key which you need to set in the settings.
For example:
This extension contributes the following settings: This extension contributes the following settings:
* `myExtension.enable`: enable/disable this extension * `codestats.apikey`: API key for your machine
* `myExtension.thing`: set to `blah` to do something
## Known Issues ## Known Issues
Calling out known issues can help limit users opening duplicate issues against your extension.
## Release Notes ## Release Notes
Users appreciate release notes as you update your extension.
### 1.0.0 ### 1.0.0
Initial release of ... Initial release of code-stats-vscode
### 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 ### For more information
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) * [Github repository](https://github.com/riussi/code-stats-vscode)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
**Enjoy!** **Enjoy!**

View File

@ -2,7 +2,7 @@
"name": "code-stats-vscode", "name": "code-stats-vscode",
"displayName": "Code::Stats", "displayName": "Code::Stats",
"description": "Code::Stats package for Visual Studio Code", "description": "Code::Stats package for Visual Studio Code",
"version": "0.1.0", "version": "1.0.0",
"publisher": "juha-ristolainen", "publisher": "juha-ristolainen",
"engines": { "engines": {
"vscode": "^1.10.0" "vscode": "^1.10.0"