From 7d7917c799121b5981b952a215e90603a39245ed Mon Sep 17 00:00:00 2001
From: Chemaclass <chemaclass@outlook.es>
Date: Fri, 19 Jun 2026 12:29:45 +0200
Subject: [PATCH 1/2] docs: remove Publish Docs badge from README

---
 README.md | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/README.md b/README.md
index e0b3acc9..adf9bf9e 100644
--- a/README.md
+++ b/README.md
@@ -5,9 +5,6 @@
     <a href="https://github.com/TypedDevs/bashunit/actions/workflows/static_analysis.yml">
         <img src="https://github.com/TypedDevs/bashunit/actions/workflows/static_analysis.yml/badge.svg" alt="Static analysis">
     </a>
-    <a href="https://github.com/TypedDevs/bashunit/actions/workflows/publish-docs.yml">
-        <img src="https://github.com/TypedDevs/bashunit/actions/workflows/publish-docs.yml/badge.svg" alt="Publish Docs">
-    </a>
     <a href="https://github.com/TypedDevs/bashunit/actions/workflows/linter.yml">
         <img src="https://github.com/TypedDevs/bashunit/actions/workflows/linter.yml/badge.svg" alt="Editorconfig checker">
     </a>

From 809c1c00673796c540ee58f1b89b1f46a9d46b5d Mon Sep 17 00:00:00 2001
From: "Jose M. Valera Reales" <5256287+Chemaclass@users.noreply.github.com>
Date: Fri, 19 Jun 2026 14:45:05 +0200
Subject: [PATCH 2/2] docs: restructure README with a quick-start section
 (#733)

---
 README.md | 44 ++++++++++++++++++++++++++++++++------------
 1 file changed, 32 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index adf9bf9e..eafbdf35 100644
--- a/README.md
+++ b/README.md
@@ -26,25 +26,45 @@
 <h1 align="center">A simple testing framework for bash scripts</h1>
 
 <p align="center">
-    Test your bash scripts in the fastest and simplest way, discover the most modern bash testing framework.
+    Test your bash scripts in the fastest and simplest way.
 </p>
 
-## Description
+## Why bashunit
 
-**bashunit** is a comprehensive and lightweight testing framework for Bash, focused on the development experience.
-It boasts hundreds of assertions and functionalities like spies, mocks, providers and more, offers concise and clear documentation, and has a very active community.
+A lightweight, fast testing framework for **Bash 3.0+**, focused on developer experience.
+It ships hundreds of assertions plus spies, mocks, data providers, snapshots and more.
 
-## Documentation
+## Quick start
 
-You can find the complete documentation for **bashunit** online, including installation instructions and the various features it provides, in the [official bashunit documentation](https://bashunit.com).
+Install the latest version into your project:
 
-## Requirements
+```bash
+curl -s https://bashunit.com/install.sh | bash
+```
 
-bashunit requires **Bash 3.0** or newer.
+Write a test in `tests/example_test.sh`:
 
-## Contribute
+```bash
+#!/usr/bin/env bash
+
+function test_bashunit_is_working() {
+  assert_same "bashunit is working" "bashunit is working"
+}
+```
+
+Run it:
+
+```bash
+./lib/bashunit tests/
+```
 
-You are welcome to contribute reporting issues, sharing ideas,
-or with your pull requests.
+Prefer learning by doing? Run `./lib/bashunit learn` for an interactive tutorial.
+
+## Documentation
+
+Full documentation, covering installation options, every feature and examples, lives at [bashunit.com](https://bashunit.com).
+
+## Contribute
 
-Make sure to read our [contribution guide](https://github.com/TypedDevs/bashunit/blob/main/.github/CONTRIBUTING.md) where you will find, among other things, how to set up your environment with the various tools we use to develop this framework.
+Issues, ideas and pull requests are welcome.
+See the [contribution guide](https://github.com/TypedDevs/bashunit/blob/main/.github/CONTRIBUTING.md) to set up your environment.