feat: updated readme

README.md

@@ -0,0 +1,27 @@
+## Examlpe usage in pipeline
+
+```groovy
+@Library('semantic@main') _
+
+podTemplate(containers: [
+    ...
+    semanticGetContainerTemplate(),
+]) {
+    ...
+    // Somewhere in the middle of stages
+    def VERSION
+    if (!PULL_REQUEST) {
+      helpers.withGiteaCreds("GitBackendCreds", "git-tool") {
+        semantic.semantic(
+          stageName: "versioning",
+          giteaTokenCredId: "Gitea-releases",
+          giteaCredId: "GitBackendCreds",
+          giteaUrl: "${env.GIT_SCHEME}${env.GIT_HOST}",
+          currentBranch: BRANCH,
+          devBranch: "develop",
+        )
+      }
+      VERSION = semantic.semanticGetVersion()
+    }
+}
+```