diff --git a/README.md b/README.md index c6fd37af6..36f4d7bcd 100644 --- a/README.md +++ b/README.md @@ -27,5 +27,6 @@ This monorepo contains code for open-source Code PushUp NPM packages: - [๐Ÿงฉ @code-pushup/utils](./packages/utils#readme) - various **utilities** (useful for custom plugins or other integrations) - plugins: - [๐Ÿ“ฆ @code-pushup/eslint-plugin](./packages/plugin-eslint#readme) - static analysis using **ESLint** rules + - [๐Ÿ“ฆ @code-pushup/coverage-plugin](./packages/plugin-coverage#readme) - code coverage analysis If you want to contribute, please refer to [CONTRIBUTING.md](./CONTRIBUTING.md). diff --git a/packages/cli/README.md b/packages/cli/README.md index 5a67a75dd..4080fb8f0 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -8,9 +8,10 @@ --- -| ๐Ÿ“Š Getting Started | ๐ŸŒ Portal Integration | ๐Ÿ› ๏ธ CI Automation | -| :--------------------------------------------------: | :------------------------------------------------: | :----------------------------------------: | -| **[How to setup](#getting-started)** a basic project | Sort, filter **[your goals](#portal-integration)** | Updates **[on every PR](#-ci-automation)** | +| ๐Ÿ“Š Getting Started | ๐ŸŒ Portal Integration | ๐Ÿ› ๏ธ CI Automation | +| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: | +| **[How to setup](#getting-started)** a basic project | Sort, filter **[your goals](#portal-integration)** | Updates **[on every PR](#-ci-automation)** | +| Getting started cover image | Portal integration cover image | CI Automation cover | --- diff --git a/packages/cli/docs/images/cli-cover.png b/packages/cli/docs/images/cli-cover.png new file mode 100644 index 000000000..be5bfd7b3 Binary files /dev/null and b/packages/cli/docs/images/cli-cover.png differ diff --git a/packages/cli/docs/images/getting-started-cover.png b/packages/cli/docs/images/getting-started-cover.png new file mode 100644 index 000000000..3717404b7 Binary files /dev/null and b/packages/cli/docs/images/getting-started-cover.png differ diff --git a/packages/cli/docs/images/portal-cover.png b/packages/cli/docs/images/portal-cover.png new file mode 100644 index 000000000..850524bbf Binary files /dev/null and b/packages/cli/docs/images/portal-cover.png differ diff --git a/packages/plugin-coverage/README.md b/packages/plugin-coverage/README.md index 10ad1f810..372f27b83 100644 --- a/packages/plugin-coverage/README.md +++ b/packages/plugin-coverage/README.md @@ -1,4 +1,4 @@ -# @code-pushup/coverage-plugin +# @code-pushup/coverage-plugin [![npm](https://img.shields.io/npm/v/%40code-pushup%2Fcoverage-plugin.svg)](https://www.npmjs.com/package/%40code-pushup%2Fcoverage-plugin) ๐Ÿงช **Code PushUp plugin for tracking code coverage.** โ˜‚๏ธ diff --git a/packages/plugin-eslint/README.md b/packages/plugin-eslint/README.md index 85028a29b..b760eea60 100644 --- a/packages/plugin-eslint/README.md +++ b/packages/plugin-eslint/README.md @@ -1,4 +1,4 @@ -# @code-pushup/eslint-plugin [![npm](https://img.shields.io/npm/v/%40code-pushup%2Fplugin-eslint.svg)](https://www.npmjs.com/package/%40code-pushup%2Fplugin-eslint) +# @code-pushup/eslint-plugin [![npm](https://img.shields.io/npm/v/%40code-pushup%2Feslint-plugin.svg)](https://www.npmjs.com/package/%40code-pushup%2Feslint-plugin) ๐Ÿ•ต๏ธ **Code PushUp plugin for detecting problems in source code using ESLint.** ๐Ÿ“‹ diff --git a/packages/plugin-lighthouse/README.md b/packages/plugin-lighthouse/README.md index 2e1cbda30..103e3908c 100644 --- a/packages/plugin-lighthouse/README.md +++ b/packages/plugin-lighthouse/README.md @@ -1,3 +1,3 @@ -# @code-pushup/lighthouse-plugin +# @code-pushup/lighthouse-plugin [![npm](https://img.shields.io/npm/v/%40code-pushup%2Flighthouse-plugin.svg)](https://www.npmjs.com/package/%40code-pushup%2Flighthouse-plugin) TODO: docs