Skip to content

Commit e48b55f

Browse files
committed
instructions on readme
1 parent fcd8862 commit e48b55f

File tree

1 file changed

+4
-51
lines changed

1 file changed

+4
-51
lines changed

README.md

Lines changed: 4 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,17 @@
11
# codacy-cli-integration
22

3-
This is the README for your extension "codacy-cli-integration". After writing up a brief description, we recommend including the following sections.
3+
An extension to see Codacy results on VSCode
44

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.
145

156
## Requirements
167

178
Codacy CLI tool depends on Docker
189

1910
## Extension Settings
2011

21-
Codacy CLI extension can be configure to both work with Project token or API Token
12+
Settings are configured on ".vscode/settings.json" under "codacy-cli".
13+
14+
Codacy CLI extension can be configured to both work with Project token or API Token
2215

2316
API token example:
2417

@@ -42,44 +35,4 @@ In order to use it for servers on-prem, you'll need to use the flag "codacy-api-
4235
"codacy-api-base-url": "https://my-onprem.codacy.instance",
4336
}
4437

45-
## Known Issues
46-
47-
Calling out known issues can help limit users opening duplicate issues against your extension.
48-
49-
## Release Notes
50-
51-
Users appreciate release notes as you update your extension.
52-
53-
### 1.0.0
54-
55-
Initial release of ...
56-
57-
### 1.0.1
58-
59-
Fixed issue #.
60-
61-
### 1.1.0
62-
63-
Added features X, Y, and Z.
64-
65-
-----------------------------------------------------------------------------------------------------------
66-
## Following extension guidelines
67-
68-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
69-
70-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
71-
72-
## Working with Markdown
73-
74-
**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
75-
76-
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
77-
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
78-
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets
79-
80-
### For more information
81-
82-
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
83-
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)
84-
8538
**Enjoy!**

0 commit comments

Comments
 (0)