Skip to content

Commit 7172042

Browse files
committed
Update readme
1 parent bbbfc1e commit 7172042

File tree

4 files changed

+7
-82
lines changed

4 files changed

+7
-82
lines changed

README.md

Lines changed: 7 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,19 @@
1-
# fluent-vue README
1+
# fluent-vue
22

3-
This is the README for your extension "fluent-vue". After writing up a brief description, we recommend including the following sections.
3+
Syntax highlighting for Fluent syntax.
44

55
## Features
66

7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
7+
* Syntax highlighting in `.ftl` files
8+
* Syntax highlighting in Vue `<fluent>` custom blocks from `fluent-vue`
89

9-
For example if there is an image subfolder under your extension project workspace:
10-
11-
\!\[feature X\]\(images/feature-x.png\)
12-
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.
14-
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.
10+
![feature X](./images/screenshot.png)
3311

3412
## Release Notes
3513

36-
Users appreciate release notes as you update your extension.
37-
3814
### 1.0.0
3915

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.
16+
Initial release of fluent-vue.
17+
Support syntax highlighting in `.ftl` files and in Vue `<fluent>` blocks.
4918

5019
---
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!**

images/logo.png

12.8 KB
Loading

images/screenshot.png

44.3 KB
Loading

vsc-extension-quickstart.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)