From 61412b0792dc22b7cdc0f71d0418ff1dfd22a0d5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mat=C4=9Bj=20Chalk?= <matej.chalk@flowup.cz>
Date: Tue, 31 Oct 2023 08:59:36 +0100
Subject: [PATCH] docs: improve READMEs with emojis and nicer formatting

---
 README.md                        |  8 +++++++-
 packages/cli/README.md           | 10 ++++++++--
 packages/core/README.md          | 10 ++++++++--
 packages/models/README.md        |  2 +-
 packages/plugin-eslint/README.md |  4 +++-
 packages/utils/README.md         |  2 +-
 6 files changed, 28 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index fe9ba0764..66e830da2 100644
--- a/README.md
+++ b/README.md
@@ -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:
 
diff --git a/packages/cli/README.md b/packages/cli/README.md
index db0936eff..eaffa8462 100644
--- a/packages/cli/README.md
+++ b/packages/cli/README.md
@@ -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.
 
diff --git a/packages/core/README.md b/packages/core/README.md
index cd6dbd286..e91f2789a 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -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).
diff --git a/packages/models/README.md b/packages/models/README.md
index 86bf065f7..970a64e4a 100644
--- a/packages/models/README.md
+++ b/packages/models/README.md
@@ -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
 
diff --git a/packages/plugin-eslint/README.md b/packages/plugin-eslint/README.md
index 44d7f0a4d..02f621569 100644
--- a/packages/plugin-eslint/README.md
+++ b/packages/plugin-eslint/README.md
@@ -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).
 
diff --git a/packages/utils/README.md b/packages/utils/README.md
index 9ea0f0c45..e1b7729b6 100644
--- a/packages/utils/README.md
+++ b/packages/utils/README.md
@@ -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