Skip to content

Commit

Permalink
docs: readme update (#718)
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
BioPhoton and matejchalk authored Jul 8, 2024
1 parent 2fd9397 commit 3d73dea
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 34 deletions.
60 changes: 26 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Code PushUp - Just Follow the Score <✓>
# Code PushUp CLI

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

[![version](https://img.shields.io/github/package-json/v/code-pushup/cli)](https://www.npmjs.com/package/%40code-pushup%2Fcli)
[![release date](https://img.shields.io/github/release-date/code-pushup/cli)](https://github.com/code-pushup/cli/releases)
Expand All @@ -9,31 +9,33 @@
[![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)
[![Codecov](https://codecov.io/gh/code-pushup/cli/branch/main/graph/badge.svg?token=Y7V489JZ4A)](https://codecov.io/gh/code-pushup/cli)

## 🌟 Why Choose Code PushUp?
---

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

- **Incomplete or missing tracking** due to a mix of portals and custom tools is costly and unreliable 💸
- **No Standards** in data and processes leads to flaky, unmaintained zombies 🧟
- **Results are spread** over multiple places and need manual steps 📂

## 🛠️ Standards for Code Quality that Integrates Any Tool
_Common problems with keeping track of technical quality:_

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

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

---

### ⚡ Flexible Config Setup
## 🔎🔬 Code quality integrations for any tool 📉🔍

- **[📦 CLI](./packages/cli#readme)** for **collecting** audit results and **uploading** reports to the portal.
- **[📦 Core Logic](./packages/core#readme)** to craft your **custom tooling**.
| [🚀 Get started](./packages/cli/README.md#getting-started)| [🤖 CI automation](https://github.com/marketplace/actions/code-pushup) |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <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> |
| <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> |

[Get started in no time!](./packages/cli/README.md#getting-started) ⏱️
| 📈 [Portal](https://code-pushup.dev#portal)| 🔌 [Custom plugins](./packages/cli/docs/custom-plugins.md) |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <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> |
| <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> |

---

Expand All @@ -48,40 +50,30 @@

---

### 🔧 Custom Plugins

- 🛠️ [Integrate your own metric with custom plugins](./packages/cli/docs/custom-plugins.md) 📚
- 📦 [@code-pushup/models](./packages/models#readme)
- **Schemas and types** for data models (useful for custom plugins or other integrations) 📊
- 📦 [@code-pushup/utils](./packages/utils#readme)
- Various **utilities** (useful for custom plugins or other integrations) 🔨

---

## 📝 How It Works!

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

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

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

4. **Wing it!**
4. **Relax!**
Watch improvements, share reports 📈

---

<table>
<tr>
<td>
<img alt="Code-Pushup Logo" src="./packages/cli/docs/images/code-pushup-logo.png" width="150px" height="192px">
<img alt="Code-Pushup Logo" src="./packages/cli/docs/images/code-pushup-logo.png" width="730">
</td>
<td>
<h2>Just follow the score</h2>
<h3>See regressions - Report scores - On every PR</h3>
<h2>Comprehensive tech quality monitoring <✓></h2>
<h3>Monitor regressions - Quantify tech debt</h3>
<!-- link when web landing is ready <a href="./packages/cli/README.md#getting-started">Try our paid features</a> -->
</td>
</tr>
Expand Down
Binary file added docs/images/code-pushup-custom-plugins.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/gh-action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3d73dea

Please sign in to comment.