docs: add README with release synchronization example

- Introduces a README file with an example for syncing releases
  between Gitea and GitHub using a GitHub Actions workflow.
- Highlights configuration details and inputs for the action.

README.md

@@ -0,0 +1,34 @@
+# Sync Releases to GitHub
+
+## Example Usage
+
+```yaml
+name: Sync Release to GitHub
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: "Release tag to synchronize"
+        required: false
+        type: string
+  release:
+    types: [published, edited]
+
+jobs:
+  sync-github:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Run Releases Sync Action
+        uses: https://git.0xmax42.io/actions/releases-sync@main
+        with:
+          gitea_token: ${{ ACTIONS_RUNTIME_TOKEN }}
+          gitea_url: https://git.0xmax42.io
+          gitea_owner: maxp
+          gitea_repo: ait
+          tag_name: ${{ inputs.tag || github.event.release.tag_name }}
+          github_token: ${{ secrets.SYNC_GITHUB_TOKEN }}
+          github_owner: 0xMax42
+          github_repo: ait
+```