Skip to content

Commit 85e911f

Browse files
committed
Description and @sdras mention #8
1 parent 03a618c commit 85e911f

File tree

1 file changed

+11
-58
lines changed

1 file changed

+11
-58
lines changed

Diff for: README.md

+11-58
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,18 @@
1-
# vue3-vscode-snippets README
1+
# Vue 3 VS Code Snippets
22

3-
This is the README for your extension "vue3-vscode-snippets". After writing up a brief description, we recommend including the following sections.
3+
## Description
44

5-
## Features
5+
These snippets were made to speed up Vue 3 development. With it you can write boilerplate code infinitely faster.
66

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7+
> I took my inspiration from [vue-vscode-snippets](https://github.com/sdras/vue-vscode-snippets) extension made by @sdras.
8+
>
9+
> A lot of snippets here were taken from that extension and then improved by me to be more useful with Vue 3 (and Vue 3 only).
810
9-
For example if there is an image subfolder under your extension project workspace:
11+
### Supported versions
1012

11-
\!\[feature X\]\(images/feature-x.png\)
13+
- Vue 3
1214

13-
> 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.
15+
## Installation
1416

15-
## Requirements
16-
17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
18-
19-
## Extension Settings
20-
21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
25-
This extension contributes the following settings:
26-
27-
* `myExtension.enable`: Enable/disable this extension.
28-
* `myExtension.thing`: Set to `blah` to do something.
29-
30-
## Known Issues
31-
32-
Calling out known issues can help limit users opening duplicate issues against your extension.
33-
34-
## Release Notes
35-
36-
Users appreciate release notes as you update your extension.
37-
38-
### 1.0.0
39-
40-
Initial release of ...
41-
42-
### 1.0.1
43-
44-
Fixed issue #.
45-
46-
### 1.1.0
47-
48-
Added features X, Y, and Z.
49-
50-
---
51-
52-
## Working with Markdown
53-
54-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
55-
56-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
57-
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
58-
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.
59-
60-
## For more information
61-
62-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
63-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
64-
65-
**Enjoy!**
17+
- You can do it by finding `Vue 3 VSCode Snippets` by `exer7um` in VS Code marketplace and clicking install.
18+
- Or you can follow [that link](https://marketplace.visualstudio.com/items?itemName=exer7um.vue3-vscode-snippets) and click install.

0 commit comments

Comments
 (0)