From de673b4f2348a162c0b70b7dd0b801f4bcacc5ef Mon Sep 17 00:00:00 2001
From: Vitor Hugo Schwaab <vitor@schwaab.dev>
Date: Tue, 3 Dec 2024 09:01:03 +0100
Subject: [PATCH] docs: adjust README

---
 README.md | 61 +++++++++++++++++++++++++++++--------------------------
 1 file changed, 32 insertions(+), 29 deletions(-)

diff --git a/README.md b/README.md
index 6e1204e..0cfe07f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-## Automatic cherry-picking
+# Automatic cherry-picking
 
 Cherry-picks commits from a merged PR, creating a new PR to a target branch.
 Allows setting a name of a submodule and will automatically fast-forward it to
@@ -6,38 +6,41 @@ also match the `target-branch`.
 
 Check [action.yml](action.yml) for a description of inputs and outputs.
 
-### Configuration sample:
+### Configuration sample
 
 ```yaml
 name: 'Cherry pick Release/candidate into develop'
 on:
-    pull_request:
-        branches:
-            - release/candidate # Branches where the original PRs will be merged
-        types:
-            - closed
+  pull_request:
+    branches:
+      - release/candidate # Branches where the original PRs will be merged
+    types:
+      - closed
 
 jobs:
-    test-cherry-pick:
-        runs-on: ubuntu-latest
-        name: Test the cherry-pick action
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-              with:
-                  fetch-depth: 0
-                  submodules: recursive #If you need to operate on submodules
-
-            - name: Cherry pick
-              id: cherry-pick
-              uses: wireapp/action-auto-cherry-pick@v1.0.2
-              with:
-                  target-branch: 'develop' # Branch which will receive the automatic cherry-picks
-                  submodules-target-branch: 'develop' # If you want the action to fast-forward the submodules to a specific branch
-                  pr-title-suffix: '🍒'
-
-            - name: Get the output
-              run:
-                  echo "The created PR number is ${{
-                  steps.hello.outputs.pr-number }}"
+  test-cherry-pick:
+    runs-on: ubuntu-latest
+    name: Test the cherry-pick action
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: recursive #If you need to operate on submodules
+
+      - name: Cherry pick
+        id: cherry-pick
+        uses: wireapp/action-auto-cherry-pick@v1.0.2
+        with:
+          # Branch which will receive the automatic cherry-picks
+          target-branch: 'develop'
+
+          # If you want the action to fast-forward the submodules to a specific branch
+          submodules-target-branch: 'develop'
+          pr-title-suffix: '🍒'
+
+      - name: Get the output
+        run:
+          echo "The created PR number is ${{
+          steps.hello.outputs.pr-number }}"
 ```