Skip to content

Commit f4e74c4

Browse files
committed
Update README.md
1 parent c3ce102 commit f4e74c4

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
![Logo](https://github.com/green-code-initiative/ecoCode/blob/main/docs/resources/logo-large.png?raw=true)
2-
======================================
32

43
Websites are becoming increasingly heavy and complex over the years. They represent an important part
54
of the digital environmental footprint. The objective of this project is to detect smells in a website source code
@@ -9,10 +8,7 @@ devices, etc. This project is part of [ecoCode](https://github.com/green-code-in
98
Rules in this repository are mainly based from book
109
[115 Web Ecodesign Best Practices](https://github.com/cnumr/best-practices).
1110
This reference is maintained by [CNumR](https://collectif.greenit.fr/), a french collective that works
12-
for a responsible design of digital services. You can find all applicable rules in
13-
the [main ecoCode repository](https://github.com/green-code-initiative/ecoCode/tree/main/docs/rules).
14-
15-
> ⚠️ This project is still in testing stage and need improvements. Any contribution will be appreciated.
11+
for a responsible design of digital services. You can find all applicable rules in the [RULES.md file](RULES.md).
1612

1713
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
1814
![Build](https://github.com/green-code-initiative/ecoCode-javascript/actions/workflows/build.yml/badge.svg)
@@ -57,7 +53,7 @@ The standalone version of the ESLint plugin is available from [npmjs](https://np
5753

5854
| Plugins Version | SonarQube version | ESLint version |
5955
|-----------------|-------------------|----------------|
60-
| 1.4.+ | 9.4.+ LTS to 10.1 | 7+ |
56+
| 1.4.+ | 9.4.+ LTS to 10.2 | 7+ |
6157

6258
🤝 Contribution
6359
---------------

eslint-plugin/README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ npm install -D eslint @ecocode/eslint-plugin
2525
> our rules.\
2626
> Follow [this official guide](https://typescript-eslint.io/getting-started) to install it in a few steps.
2727
28+
#### Are you working with a GitHub Packages registry?
29+
30+
The plugin is also available from GitHub npm registry under "green-code-initiative" scope:
31+
32+
```sh
33+
# yarn
34+
yarn add -D eslint @green-code-initiative/ecocode-eslint-plugin
35+
# npm
36+
npm install -D eslint @green-code-initiative/ecocode-eslint-plugin
37+
```
38+
2839
### Enable whole plugin
2940

3041
Add `@ecocode` recommended configuration to `extends` section of your `.eslintrc`:
@@ -57,7 +68,7 @@ Add `@ecocode` to the `plugins` section of your `.eslintrc`, followed by rules c
5768
✅ Set in the `recommended` configuration.
5869

5970
| Name | Description | ⚠️ |
60-
| :------------------------------------------------------------------------------------- | :--------------------------------------------------------- | :- |
71+
|:---------------------------------------------------------------------------------------|:-----------------------------------------------------------|:---|
6172
| [avoid-css-animations](docs/rules/avoid-css-animations.md) | Avoid usage of CSS animations ||
6273
| [avoid-high-accuracy-geolocation](docs/rules/avoid-high-accuracy-geolocation.md) | Avoid using high accuracy geolocation in web applications. ||
6374
| [limit-db-query-results](docs/rules/limit-db-query-results.md) | Should limit the number of returns for a SQL query ||

0 commit comments

Comments
 (0)