diff --git a/README.md b/README.md index 9ede0732..62b087f5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,16 @@ Eco-CI is a project aimed at estimating energy consumption in continuous integration (CI) environments. It provides functionality to calculate the energy consumption of CI jobs based on the power consumption characteristics of the underlying hardware. +## Compatibility + +The plugin is tested on: +- `ubuntu-latest` (22.04 at the time of writing) +- `ubuntu-24.04` + +It is known to not work on `ubuntu-20.04` ([See here](https://github.com/green-coding-solutions/eco-ci-energy-estimation/issues/72)) + +Also Windows and macOS are currently not supported. + ## Usage Eco-CI supports both GitHub and GitLab as CI platforms. When you integrate it into your pipeline, you must call the start-measurement script to begin collecting power consumption data, then call the get-measurement script each time you wish to make a spot measurement. When you call get-measurment, you can also assign a label to it to more easily identify the measurement. At the end, call the display-results to see all the measurement results, overall total usage, and export the data.