Merge pull request #27 from Webperf-se/readme

Improved README with example and plugin info

Author: 7h3Rabbit

README.md

@@ -6,9 +6,17 @@ webperf-core plugin for sitespeed.io.
 
 The `plugin-webperf-core` is a plugin used by the [webperf_core](https://github.com/Webperf-se/webperf_core) repository. It is designed to collect data from other sitespeed.io plugins, such as [@sitespeedio/plugin-lighthouse](https://github.com/sitespeedio/plugin-lighthouse). The main goal of this plugin is to move sitespeed.io specific logic into sitespeed.io plugins instead of having them directly in `webperf_core`.
 
+Additionally, this plugin summarizes supported plugins into a single tab (webperf core), instead of each plugin having its own tab. This approach makes it easier to get a quick overview, reduces clutter, and simplifies identifying the best next issue to improve.
+
 ## Features
 
-- Collects data from various sitespeed.io plugins like [@sitespeedio/plugin-lighthouse](https://github.com/sitespeedio/plugin-lighthouse).
+- Collects data from various sitespeed.io plugins like:
+  - [plugin-css](https://github.com/Webperf-se/plugin-css)
+  - [plugin-html](https://github.com/Webperf-se/plugin-html)
+  - [plugin-javascript](https://github.com/Webperf-se/plugin-javascript)
+  - [plugin-pagenotfound](https://github.com/Webperf-se/plugin-pagenotfound)
+  - [plugin-accessibility-statement](https://github.com/Webperf-se/plugin-accessibility-statement)
+  - [@sitespeedio/plugin-lighthouse](https://github.com/sitespeedio/plugin-lighthouse)
 - Centralizes sitespeed.io specific logic, keeping it separate from the `webperf_core` repository.
 - Provides a streamlined integration with sitespeed.io for better maintainability and modularity.
 - Enables easy configuration and use within sitespeed.io environments.
@@ -21,6 +29,12 @@ To install the plugin, run the following command:
 npm install plugin-webperf-core
 ```
 
+It is also recommended to install the related plugins listed in the Features section for full functionality:
+
+```sh
+npm install plugin-css plugin-html plugin-javascript plugin-pagenotfound plugin-accessibility-statement @sitespeedio/plugin-lighthouse
+```
+
 ## Usage
 
 To use the plugin with sitespeed.io, add it to your sitespeed.io configuration file or command line options.
@@ -47,12 +61,14 @@ You can also enable the plugin via the command line:
 sitespeed.io --plugins.add plugin-webperf-core
 ```
 
+Remember to also add all plugins you want to have information from, like the plugin-javascript plugin.
+
 ## Example
 
 Here is an example of how to use the plugin with sitespeed.io:
 
 ```sh
-sitespeed.io https://www.example.com --plugins.add plugin-webperf-core
+sitespeed.io --plugins.add plugin-webperf-core --plugins.add plugin-css --plugins.add plugin-html --plugins.add plugin-javascript --plugins.add plugin-pagenotfound --plugins.add plugin-accessibility-statement --plugins.add @sitespeedio/plugin-lighthouse https://www.example.com
 ```
 
 ## Development
@@ -89,6 +105,11 @@ Contributions are welcome! Please open an issue or submit a pull request on GitH
 
 ## Acknowledgements
 
-- [sitespeed.io](https://www.sitespeed.io/)
-- [webperf-sitespeedio-plugin](https://www.npmjs.com/package/webperf-sitespeedio-plugin)
+- [plugin-css](https://github.com/Webperf-se/plugin-css)
+- [plugin-html](https://github.com/Webperf-se/plugin-html)
+- [plugin-javascript](https://github.com/Webperf-se/plugin-javascript)
+- [plugin-pagenotfound](https://github.com/Webperf-se/plugin-pagenotfound)
+- [plugin-accessibility-statement](https://github.com/Webperf-se/plugin-accessibility-statement)
+- [@sitespeedio/plugin-lighthouse](https://github.com/sitespeedio/plugin-lighthouse)
 - [webperf_core](https://github.com/Webperf-se/webperf_core)
+- [sitespeed.io](https://www.sitespeed.io/)