Skip to content

Commit 3d73dea

Browse files
docs: readme update (#718)
Missing here is that all img's in a table have the same width. This i will add in a new PR. <img width="276" alt="Screenshot 2024-06-23 at 16 12 27" src="https://github.com/code-pushup/cli/assets/10064416/283b494e-2209-4c15-a3ac-dda8731506a3"> --------- Co-authored-by: Matěj Chalk <34691111+matejchalk@users.noreply.github.com>
1 parent 2fd9397 commit 3d73dea

File tree

4 files changed

+26
-34
lines changed

4 files changed

+26
-34
lines changed

README.md

Lines changed: 26 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Code PushUp - Just Follow the Score <✓>
1+
# Code PushUp CLI
22

3-
**🔎🔬 Code quality integrations for any tool 📉🔍**
3+
**Comprehensive tech quality monitoring <✓>**
44

55
[![version](https://img.shields.io/github/package-json/v/code-pushup/cli)](https://www.npmjs.com/package/%40code-pushup%2Fcli)
66
[![release date](https://img.shields.io/github/release-date/code-pushup/cli)](https://github.com/code-pushup/cli/releases)
@@ -9,31 +9,33 @@
99
[![CI](https://github.com/code-pushup/cli/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/code-pushup/cli/actions/workflows/ci.yml?query=branch%3Amain)
1010
[![Codecov](https://codecov.io/gh/code-pushup/cli/branch/main/graph/badge.svg?token=Y7V489JZ4A)](https://codecov.io/gh/code-pushup/cli)
1111

12-
## 🌟 Why Choose Code PushUp?
12+
---
1313

1414
### 🔌 Code quality tools are like phone chargers. Everyone has a different plug.
1515

16-
- **Incomplete or missing tracking** due to a mix of portals and custom tools is costly and unreliable 💸
17-
- **No Standards** in data and processes leads to flaky, unmaintained zombies 🧟
18-
- **Results are spread** over multiple places and need manual steps 📂
19-
20-
## 🛠️ Standards for Code Quality that Integrates Any Tool
16+
_Common problems with keeping track of technical quality:_
2117

22-
### 🚀 Automated CI Integration
18+
- When **tech debt is invisible**, it's difficult to plan much-needed maintenance efforts 🔧
19+
- Individual tools measure different metrics, inability to combine them leads to
20+
a **lack of comprehensive overview** 🧑‍🦯
21+
- Open-source tools typically used for failing checks in CI, which **can't measure incremental improvements** due to arbitrary pass/fail thresholds 🤖
22+
- Off-the-shelf solutions tend to be opinionated and **hard to customize**, so may not fit your specific needs 🧱
2323

24-
- **Seamless integration** into any CI pipeline with full control. ⚙️
25-
- Our tool **works on all platforms** like GitHub, Gitlab, etc. 🌐
26-
- Even custom tooling can be created over the 📦 [@code-pushup/core](./packages/core#readme) package
27-
- Get updates [on every PR](https://github.com/marketplace/actions/code-pushup)! 🔄
24+
_We want to change that!_
2825

2926
---
3027

31-
### ⚡ Flexible Config Setup
28+
## 🔎🔬 Code quality integrations for any tool 📉🔍
3229

33-
- **[📦 CLI](./packages/cli#readme)** for **collecting** audit results and **uploading** reports to the portal.
34-
- **[📦 Core Logic](./packages/core#readme)** to craft your **custom tooling**.
30+
| [🚀 Get started](./packages/cli/README.md#getting-started)| [🤖 CI automation](https://github.com/marketplace/actions/code-pushup) |
31+
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
32+
| <a href="./packages/cli/README.md#getting-started"><img alt="Getting started cover image" title="Getting started with code-pushup" src="packages/cli/docs/images/cli-terminal-overview.png" max-height="200" width="auto"></a> | <a href="./packages/cli/README.md#-ci-automation"><img alt="CI Automation cover" title="CI automation guide" src="docs/images/gh-action.png" max-height="200" width="auto"></a> |
33+
| <ul><li>Run **[📦 `@code-pushup/cli`](./packages/cli#readme)** to collect **reports**.</li><li>[Get started](./packages/cli/README.md#getting-started) quickly with our [**official plugins**](#-officially-supported-plugins)! ⏱️</li></ul> | <ul><li>Easy **CI** setup with **[🤖 `code-pushup/github-action`](https://github.com/marketplace/actions/code-pushup)**.</li><li>Import logic from **[📦 `@code-pushup/core`](./packages/core#readme)** to craft **custom tools**.</li></ul> |
3534

36-
[Get started in no time!](./packages/cli/README.md#getting-started) ⏱️
35+
| 📈 [Portal](https://code-pushup.dev#portal)| 🔌 [Custom plugins](./packages/cli/docs/custom-plugins.md) |
36+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
37+
| <a href="#portal-integration"><img alt="Portal integration cover image" title="Inetegrate code-pushup portal" src="packages/cli/docs/images/portal-cover.png" max-height="200" width="auto"></a> | <a href="#custom-plugins"><img alt="Custom plugins" title="Create custom code-pushup plugins" src="docs/images/code-pushup-custom-plugins.png" max-height="200" width="auto"></a> |
38+
| <ul><li>**[Portal](https://code-pushup.dev#portal)** 🌐 **visualizes reports** in a slick UI.</li><li>Track **historical data** from uploads. ⬆️</li></ul> | <ul><li>All the [data models](./packages/models/docs/models-reference.md) you need are provided in **[📦 `@code-pushup/models`](./packages/models/README.md)**.</li><li>Find tons of useful utilities in **[📦 `@code-pushup/utils`](./packages/utils/README.md)**.</li></ul> |
3739

3840
---
3941

@@ -48,40 +50,30 @@
4850

4951
---
5052

51-
### 🔧 Custom Plugins
52-
53-
- 🛠️ [Integrate your own metric with custom plugins](./packages/cli/docs/custom-plugins.md) 📚
54-
- 📦 [@code-pushup/models](./packages/models#readme)
55-
- **Schemas and types** for data models (useful for custom plugins or other integrations) 📊
56-
- 📦 [@code-pushup/utils](./packages/utils#readme)
57-
- Various **utilities** (useful for custom plugins or other integrations) 🔨
58-
59-
---
60-
6153
## 📝 How It Works!
6254

63-
1. **Configure**
55+
1. **[Configure](./packages/cli/README.md#getting-started)**
6456
Pick from a set of supported packages or include your own ideas. 🧩
6557

66-
2. **Integrate**
58+
2. **[Integrate](https://github.com/marketplace/actions/code-pushup)**
6759
Use our integration guide and packages to set up CI integration in minutes. ⏱️
6860

69-
3. **Observe**
61+
3. **[Observe](https://code-pushup.dev#portal)**
7062
Guard regressions and track improvements with every code change. 🔍
7163

72-
4. **Wing it!**
64+
4. **Relax!**
7365
Watch improvements, share reports 📈
7466

7567
---
7668

7769
<table>
7870
<tr>
7971
<td>
80-
<img alt="Code-Pushup Logo" src="./packages/cli/docs/images/code-pushup-logo.png" width="150px" height="192px">
72+
<img alt="Code-Pushup Logo" src="./packages/cli/docs/images/code-pushup-logo.png" width="730">
8173
</td>
8274
<td>
83-
<h2>Just follow the score</h2>
84-
<h3>See regressions - Report scores - On every PR</h3>
75+
<h2>Comprehensive tech quality monitoring <✓></h2>
76+
<h3>Monitor regressions - Quantify tech debt</h3>
8577
<!-- link when web landing is ready <a href="./packages/cli/README.md#getting-started">Try our paid features</a> -->
8678
</td>
8779
</tr>
88.6 KB
Loading

docs/images/gh-action.png

158 KB
Loading
Loading

0 commit comments

Comments
 (0)