From 8a5fe205db8ae85bae92c10a0a620d54604479a4 Mon Sep 17 00:00:00 2001
From: Yurii Puchkov <panpuchkov@gmail.com>
Date: Wed, 27 Dec 2023 20:47:39 -0700
Subject: [PATCH] docs: Update examples in the README.md file

---
 README.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 68 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7adfaa9..46f63ed 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,22 @@ Features:
 
 You may use it as a Python package or a Docker container.
 
-## PIP Package
+## Usage of PIP Package (python is required)
 
+### Check commit message
+
+```shell
+$ pygitver --check-commit-message "feat: conventional commmit example"
+$ echo $?
+0
+$ pygitver --check-commit-message "non-conventional commmit example"
+ERROR: Commit does not fit Conventional Commits requirements
+More about Conventional Commits: https://www.conventionalcommits.org/en/v1.0.0/
+$ echo $?
+1
+```
+
+### Get current/next version
 ```shell
 $ git tag -l
 v0.0.1
@@ -19,11 +33,62 @@ $ pygitver --curr-ver
 v0.0.2
 $ pygitver --next-ver
 v0.0.3
-
 ```
 
+### Generate changelog
+```shell
+$ pygitver changelog
+##########
+Change Log
+##########
+
+Version v0.0.3
+=============
+
+Features
+--------
+
+* Allow to trigger job manually
+
+Bug Fixes
+---------
+
+* Path for the default changelog template
+
+* Readme.md usage
+
+Improved Documentation
+----------------------
+
+* Add examples to the readme.md
+
+$ pygitver changelog --format json | jq .
+{
+  "version": "v0.0.3",
+  "bump_rules": {
+    "major": false,
+    "minor": false,
+    "patch": true
+  },
+  "changelog": {
+    "features": [
+      "allow to trigger job manually"
+    ],
+    "bugfixes": [
+      "path for the default changelog template",
+      "README.md usage"
+    ],
+    "deprecations": [],
+    "others": [],
+    "docs": [
+      "Add examples to the README.md"
+    ],
+    "non_conventional_commit": []
+  }
+}
+```
 
-## Docker Container
+## Usage of Docker container (docker engine is required)
 
 ```shell
 $ git tag -l