Skip to content

Commit 12d8260

Browse files
committed
Update README
1 parent 3e7f6eb commit 12d8260

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,14 @@ The purpose of these linters is twofold: to allow code smells to be found as soo
2929
techonologies, and also to trace these reports back into SonarQube. This way we can make up for a SonarQube lack by
3030
improving feedback to developers. It's a good deal! And the use is not more complex.
3131

32-
🌿 Use with our SonarQube plugin
33-
--------------------------------
32+
🌿 Use with our SonarQube plugins
33+
---------------------------------
3434

35-
Not available right now. Coming soon!
35+
Linters in this repository are primally designed to work with our SonarQube plugins.\
36+
Check one of the guides below to install a SonarQube plugin and its associated linter:
37+
38+
- [JavaScript plugin guide](https://github.com/green-code-initiative/ecoCode/blob/main/javascript-plugin/README.md)
39+
- More to come..
3640

3741
🔧 Use as standalone linters
3842
----------------------------
@@ -46,7 +50,13 @@ Plugins are working nicely on their own! Follow instructions in the dedicated RE
4650
🛒 Distribution
4751
---------------
4852

49-
Plugins are available as dedicated NPM packages.\
53+
SonarQube plugins can be downloaded from _ecoCode_ repository.\
54+
Linters are available as dedicated NPM packages.
55+
56+
| SonarQube plugin | Linter name | Latest version |
57+
|:-------------------------------------|:--------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------|
58+
| [JavaScript][ecoCode-latest-release] | [@ecocode/eslint-plugin](eslint-plugin/README.md) | [![eslint-plugin version](https://img.shields.io/npm/v/@ecocode/eslint-plugin)](https://npmjs.com/package/@ecocode/eslint-plugin) |
59+
5060
You can follow changelogs on [GitHub Releases page](https://github.com/green-code-initiative/ecoCode-linter/releases).
5161

5262
🤝 Contribution
@@ -57,3 +67,5 @@ We are open to your suggestions and contributions! Open an issue or PR 🚀
5767

5868
Check out the [CONTRIBUTING.md](CONTRIBUTING.md) file
5969
and follow the various guides to start contributing.
70+
71+
[ecoCode-latest-release]: https://github.com/green-code-initiative/ecoCode/releases/latest

0 commit comments

Comments
 (0)