Skip to content

Commit

Permalink
docs: improve READMEs with emojis and nicer formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
matejchalk committed Oct 31, 2023
1 parent d9e5b70 commit 61412b0
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 8 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Code PushUp CLI

**Quality metrics for your software project. Configure what you want to track using your favourite tools, integrate it in your CI and visualize reports in a beautiful dashboard.**
🔎🔬 **Quality metrics for your software project.** 📉🔍

1. ⚙️ **Configure what you want to track using your favourite tools.**
2. 🤖 **Integrate it in your CI.**
3. 🌈 **Visualize reports in a beautiful dashboard.**

---

This monorepo contains code for open-source Code PushUp NPM packages:

Expand Down
10 changes: 8 additions & 2 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# @code-pushup/cli

**Quality metrics for your software project. Configure what you want to track using your favourite tools, integrate it in your CI and visualize reports in a beautiful dashboard.**
🔎🔬 **Quality metrics for your software project.** 📉🔍

The Code PushUp CLI serves to collect audit results, and optionally upload the report to the Code PushUp portal.
1. ⚙️ **Configure what you want to track using your favourite tools.**
2. 🤖 **Integrate it in your CI.**
3. 🌈 **Visualize reports in a beautiful dashboard.**

---

The Code PushUp CLI serves to **collect audit results**, and optionally **upload the report** to the Code PushUp portal.

It can be used locally in your repository, or integrated in your CI environment.

Expand Down
10 changes: 8 additions & 2 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# @code-pushup/core

**Quality metrics for your software project. Configure what you want to track using your favourite tools, integrate it in your CI and visualize reports in a beautiful dashboard.**
🔎🔬 **Quality metrics for your software project.** 📉🔍

This package contains the core business logic for the Code PushUp CLI.
1. ⚙️ **Configure what you want to track using your favourite tools.**
2. 🤖 **Integrate it in your CI.**
3. 🌈 **Visualize reports in a beautiful dashboard.**

---

This package contains the **core business logic** for the Code PushUp CLI.

For most use cases, you'll probably want to use the [@code-pushup/cli](../cli/README.md) package instead.
The core package is useful if you prefer programmatic usage (avoids going through the command line).
Expand Down
2 changes: 1 addition & 1 deletion packages/models/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @code-pushup/models

Model definitions and validators for the [Code PushUp CLI](../cli/README.md).
**Model definitions and validators** for the [Code PushUp CLI](../cli/README.md).

## Setup

Expand Down
4 changes: 3 additions & 1 deletion packages/plugin-eslint/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# @code-pushup/eslint-plugin

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

---

The plugin parses your ESLint configuration and lints targetted files using [ESLint's Node.js API](https://eslint.org/docs/latest/integrate/nodejs-api).

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @code-pushup/utils

Low-level utilities (helper functions, etc.) used by [Code PushUp CLI](../cli/README.md).
Low-level **utilities** (helper functions, etc.) used by [Code PushUp CLI](../cli/README.md).

## Setup

Expand Down

0 comments on commit 61412b0

Please sign in to comment.