|
1 | | -# vscode-enarx README |
| 1 | +# vscode-enarx |
2 | 2 |
|
3 | | -This is the README for your extension "vscode-enarx". After writing up a brief description, we recommend including the following sections. |
| 3 | +The Enarx VS Code extension provides developers with a set of tools to help them learn, develop, test, and deploy applications to an [Enarx Keep](https://enarx.dev). |
4 | 4 |
|
5 | 5 | ## Features |
6 | 6 |
|
7 | | -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 7 | +The following features are provided: |
| 8 | +- Setup Enarx on the developer's system (Windows, MacOS, Linux) |
| 9 | +- Setup developer tools for a chosen toolchain (.NET, Rust, etc) |
| 10 | +- Download examples from [Codex](https://github.com/enarx/codex) |
| 11 | +- Upload and download applications to/from [Drawbridge](https://enarx.dev/docs/Running/Publish) |
| 12 | +- Validate [Enarx.toml](https://enarx.dev/docs/Running/Enarx_toml) |
| 13 | +- Deploy applications locally or remotely. |
8 | 14 |
|
9 | | -For example if there is an image subfolder under your extension project workspace: |
| 15 | +## Author(s) |
| 16 | +- [Mayank Kumar](https://github.com/mayankkumar2) |
10 | 17 |
|
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. |
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 | | -## Following extension guidelines |
53 | | - |
54 | | -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. |
55 | | - |
56 | | -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) |
57 | | - |
58 | | -## Working with Markdown |
59 | | - |
60 | | -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
61 | | - |
62 | | -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). |
63 | | -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). |
64 | | -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. |
65 | | - |
66 | | -## For more information |
67 | | - |
68 | | -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
69 | | -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
70 | | - |
71 | | -**Enjoy!** |
| 18 | +## License |
| 19 | +- [Apache 2.0](LICENSE) |
0 commit comments