Skip to content

Commit aebe52f

Browse files
committed
Update README and clean out unneeded files
1 parent 6940de0 commit aebe52f

File tree

3 files changed

+10
-110
lines changed

3 files changed

+10
-110
lines changed

CHANGELOG.md

-9
This file was deleted.

README.md

+10-59
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,21 @@
1-
# openjdk-dev README
1+
# OpenJDK Development Support Extension
22

3-
This is the README for your extension "openjdk-dev". After writing up a brief description, we recommend including the following sections.
3+
This is a Visual Studio Code extension that provides support OpenJDK
4+
development. The primary audience is active developers in OpenJDK projects.
45

5-
## Features
6-
7-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
8-
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.
6+
Currently, the extension provides basic integration with GitHub, but the
7+
intention is to keep adding functionality that is relevant to OpenJDK
8+
developers. If you have any ideas or suggestions, please let me know!
189

1910
## Extension Settings
2011

21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22-
23-
For example:
24-
2512
This extension contributes the following settings:
2613

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.
14+
* `openjdkDevel.github.apiToken`: GitHub API token needed for GitHub integration
15+
* `openjdkDevel.locale`: override locale for formatting of e.g. dates
3316

3417
## Release Notes
3518

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-
## Following extension guidelines
52-
53-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
54-
55-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
56-
57-
## Working with Markdown
58-
59-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
60-
61-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
62-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
63-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
64-
65-
### For more information
66-
67-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
68-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
19+
### 0.0.1
6920

70-
**Enjoy!**
21+
Initial release. This includes basic GitHub integration.

vsc-extension-quickstart.md

-42
This file was deleted.

0 commit comments

Comments
 (0)