From eb50e21241920ade4fd8d556bcafff1167d69f2d Mon Sep 17 00:00:00 2001
From: Skydust <evann.jallet@gmail.com>
Date: Fri, 27 Dec 2024 16:10:27 +0100
Subject: [PATCH] Updated the README

---
 README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2b4208f..7213644 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,46 @@
-# docker-login-skydust
+# Auto rebase
 
+An auto-rebase action that automatically determines dependencies.
+
+## Usage
+
+Defaults:
+```
+branchesToIgnore: "dev,main,master"
+mainBranch: "dev"
+```
+
+Simple workflow:
+```yaml
+name: Rebase Remote Branches
+
+on:
+  push:
+    branches:
+      - dev
+
+# Disable multiple workflows at the same time
+concurrency:
+  group: ${{ github.head_ref || github.ref_name }}
+
+jobs:
+  rebase-branches:
+    runs-on: skydust-runner
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Rebase
+        uses: https://gitea.skydust.fr/actions/auto-rebase@main
+        with:
+          branchesToIgnore: "dev,master"
+          mainBranch: "dev"
+```
+
+## Dev
+
+Simply run: `yarn install`
+And run the script locally with: `yarn dev`
+
+When committing, husky will automatically build.