From b186cd9244c258c3207d929761721f523f622fcb Mon Sep 17 00:00:00 2001
From: Koen Eijkemans <koen.eijkemans@gmail.com>
Date: Sun, 5 Jul 2020 12:11:22 +0200
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..39a2626
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# semantic-git-version-action
+Github action that extracts a version number from the git branch name
+
+ex: releases/release-v1.0.0 -> 1.0.0
+
+## Outputs
+
+| Output |  |
+| ------ | ------ |
+| VERSION |The full extracted version |
+| MAJOR_VERSION | Major version extracted from the name. First digit in the version scheme |
+| MINOR_VERSION | Minor version extracted from the name. Second digit in the version scheme (if present) |
+| PATCH_VERISON | Patch version extracted from the name. Third digit in the version scheme (if present) |
+
+This plugin only looks at the first 3 digits, rest is ignored.