From 307f527997e97e3526ef6ca4ab395daec6c1b7f5 Mon Sep 17 00:00:00 2001 From: Damien Retzinger Date: Thu, 7 May 2026 10:31:33 -0400 Subject: [PATCH] docs: add short description to README --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 011f650..c6e5ba9 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ Opinionated Github Actions and Workflows to make building, testing, and maintain ## Workflows +If you are new here, start with a reusable workflow. They are pre-built CI pipelines that you can adopt in minutes — no deep knowledge of the individual actions required. Pick the one that matches your project type and call it from your own workflow file. + | Workflow Name | Description | | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | [Integration Test](./.github/workflows/integration-README.md) | A Github Workflow that runs the Integration Tests of a Magento Package | @@ -25,6 +27,9 @@ Opinionated Github Actions and Workflows to make building, testing, and maintain ## Actions +If the reusable workflows do not fit your needs, the individual actions are the building blocks they are composed from. Use these when you need full control over your pipeline. + + | Action Name | Description | | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------- | | [Fix Magento Install](./fix-magento-install/README.md) | A Github Action that fixes Magento before `composer install` |