Initial commit

1 files changed, 54 insertions, 1 deletions

diff --git a/README.md b/README.md
index e309882..3dadf27 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,54 @@
-# version_compare
\ No newline at end of file
+# version_compare
+
+```
+usage: version_compare {{v} | {v1} {operator} {v2}}
+{v} execution example:
+    version_compare "1.2.3 >  1.2.3"
+    0
+    version_compare "1.2.3 >= 1.2.3"
+    1
+    version_compare "1.2.3 <  1.2.3"
+    0
+    version_compare "1.2.3 <= 1.2.3"
+    1
+    version_compare "1.2.3 != 1.2.3"
+    0
+    version_compare "1.2.3 =  1.2.3"
+    1
+
+{v1} {operator} {v2} execution example:
+    version_compare "1.2.3" ">"  "1.2.3"
+    0
+    version_compare "1.2.3" ">=" "1.2.3"
+    1
+    version_compare "1.2.3" "<"  "1.2.3"
+    0
+    version_compare "1.2.3" "<=" "1.2.3"
+    1
+    version_compare "1.2.3" "!=" "1.2.3"
+    0
+    version_compare "1.2.3" "="  "1.2.3"
+    1
+```
+
+## Example
+
+```shell
+#!/usr/bin/env bash
+
+v1=1.0.0
+v2=1.0.1
+op='>='
+
+result=$(version_compare "$v1 $op $v2")
+if [ -z "$result" ]; then
+    # operation failed
+    exit 1
+fi
+
+if (( result )); then
+    # operation true
+else
+    # operation false
+fi
+```
\ No newline at end of file