Skip to content

Commit 4018288

Browse files
authored
docs(cli): add docs images (#476)
1 parent 34621a2 commit 4018288

8 files changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,6 @@ This monorepo contains code for open-source Code PushUp NPM packages:
2727
- [🧩 @code-pushup/utils](./packages/utils#readme) - various **utilities** (useful for custom plugins or other integrations)
2828
- plugins:
2929
- [📦 @code-pushup/eslint-plugin](./packages/plugin-eslint#readme) - static analysis using **ESLint** rules
30+
- [📦 @code-pushup/coverage-plugin](./packages/plugin-coverage#readme) - code coverage analysis
3031

3132
If you want to contribute, please refer to [CONTRIBUTING.md](./CONTRIBUTING.md).

packages/cli/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@
88

99
---
1010

11-
| 📊 Getting Started | 🌐 Portal Integration | 🛠️ CI Automation |
12-
| :--------------------------------------------------: | :------------------------------------------------: | :----------------------------------------: |
13-
| **[How to setup](#getting-started)** a basic project | Sort, filter **[your goals](#portal-integration)** | Updates **[on every PR](#-ci-automation)** |
11+
| 📊 Getting Started | 🌐 Portal Integration | 🛠️ CI Automation |
12+
| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------: |
13+
| **[How to setup](#getting-started)** a basic project | Sort, filter **[your goals](#portal-integration)** | Updates **[on every PR](#-ci-automation)** |
14+
| <a href="#getting-started"><img alt="Getting started cover image" title="Getting started with code-pushup" src="./docs/images/getting-started-cover.png" max-height="200" width="auto"></a> | <a href="#portal-integration"><img alt="Portal integration cover image" title="Inetegrate code-pushup portal" src="./docs/images/portal-cover.png" max-height="200" width="auto"></a> | <a href="#-ci-automation"><img alt="CI Automation cover" title="CI automation guide" src="./docs/images/cli-cover.png" max-height="200" width="auto"></a> |
1415

1516
---
1617

81.2 KB
Loading
114 KB
Loading
91.3 KB
Loading

packages/plugin-coverage/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @code-pushup/coverage-plugin
1+
# @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)
22

33
🧪 **Code PushUp plugin for tracking code coverage.** ☂️
44

packages/plugin-eslint/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @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)
1+
# @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)
22

33
🕵️ **Code PushUp plugin for detecting problems in source code using ESLint.** 📋
44

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# @code-pushup/lighthouse-plugin
1+
# @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)
22

33
TODO: docs

0 commit comments

Comments
 (0)