From 15c758cd63e4c53eb7affdf1c40161429329ba10 Mon Sep 17 00:00:00 2001
From: Jan Gleytenhoover <krisellp9@gmail.com>
Date: Sun, 25 Aug 2024 16:14:09 +0000
Subject: [PATCH] docs: Add redme

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..82fac23
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+### Example usage
+
+```yaml
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for npm provenance
+    steps:
+      - name: Create Release
+        uses: https://git.kjan.de/actions/semantic-release@main
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
+```
+
+### Also dont forget to add a config
+
+release.config.cjs
+```
+module.exports = {
+
+  branches: ['main'],
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    '@semantic-release/changelog',
+      ["@saithodev/semantic-release-gitea", {
+      "giteaUrl": "https://git.kjan.de"
+    }],
+  ],
+};
+
+
+```
\ No newline at end of file