From c3175315de8c7378ba575e2ab12733de02037d9e Mon Sep 17 00:00:00 2001 From: Tobe O Date: Mon, 12 Nov 2018 04:43:28 -0500 Subject: [PATCH] README --- angel_vscode/README.md | 70 ++++++------------------------------------ 1 file changed, 9 insertions(+), 61 deletions(-) diff --git a/angel_vscode/README.md b/angel_vscode/README.md index 8384ba32..96ccd6c0 100644 --- a/angel_vscode/README.md +++ b/angel_vscode/README.md @@ -1,65 +1,13 @@ -# angel-dart-vscode README +# Angel Framework support for VSCode +![The Angel Framework](https://angel-dart.github.io/assets/images/logo.png) -This is the README for your extension "angel-dart-vscode". After writing up a brief description, we recommend including the following sections. +This extension provides IDE support within VSCode for the +[Angel](https://angel-dart.github.io) +Web server framework. The goal of this package is to improve +the overall development experience when working with Angel. ## 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 macOS or `Ctrl+\` on Windows and Linux) -* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux) -* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) 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!** +- Dart snippets for Angel framework code +- Syntax highlighting for the Jael templating engine +- **COMING SOON:** Language server support for Jael