Merge pull request #8 from vroncevic/dev

[check_mysqldb] Updated docs

README.md

@@ -1,9 +1,11 @@
 # Checking MySQL DB
 
-**check_mysqldb** is shell tool for checking MySQL database.
+**check_mysqldb** is shell tool for checking **[MySQL database](https://mariadb.org/)**.
 
 Developed in [bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) code: **100%**.
 
+[![check_mysqldb shell checker](https://github.com/vroncevic/check_mysqldb/workflows/check_mysqldb%20shell%20checker/badge.svg)](https://github.com/vroncevic/check_mysqldb/actions?query=workflow%3A%22check_mysqldb+shell+checker%22)
+
 The README is used to introduce the tool and provide instructions on
 how to install the tool, any machine dependencies it may have and any
 other information that should be provided before the tool is installed.
@@ -40,6 +42,8 @@ cp -R ~/sh_tool/log/   /root/scripts/check_mysqldb/ver.1.0/
 
 Or You can use docker to create image/container.
 
+[![check_mysqldb docker checker](https://github.com/vroncevic/check_mysqldb/workflows/check_mysqldb%20docker%20checker/badge.svg)](https://github.com/vroncevic/check_mysqldb/actions?query=workflow%3A%22check_mysqldb+docker+checker%22)
+
 ### Usage
 
 ```

docs/build/html/_sources/index.rst.txt

@@ -1,14 +1,14 @@
-CHECK_MYSQLDB
+check_mysqldb
 --------------
 
-.. toctree::
- :hidden:
+**check_mysqldb** is shell tool for checking `MySQL database <https://mariadb.org/>`_.
 
- self
+Developed in `bash <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`_ code: **100%**.
 
-**check_mysqldb** is shell tool for checking MySQL database.
+|GitHub shell checker|
 
-Developed in `bash <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`_ code: **100%**.
+.. |GitHub shell checker| image:: https://github.com/vroncevic/check_mysqldb/workflows/check_mysqldb%20shell%20checker/badge.svg
+   :target: https://github.com/vroncevic/check_mysqldb/actions?query=workflow%3A%22check_mysqldb+shell+checker%22
 
 The README is used to introduce the tool and provide instructions on
 how to install the tool, any machine dependencies it may have and any
@@ -25,7 +25,12 @@ other information that should be provided before the tool is installed.
 .. |Documentation Status| image:: https://readthedocs.org/projects/check_mysqldb/badge/?version=latest
    :target: https://check_mysqldb.readthedocs.io/projects/check_mysqldb/en/latest/?badge=latest
 
-INSTALLATION
+.. toctree::
+    :hidden:
+
+    self
+
+Installation
 -------------
 
 Navigate to release `page`_ download and extract release archive.
@@ -42,13 +47,20 @@ To install **check_mysqldb** type the following:
    cp -R ~/sh_tool/conf/  /root/scripts/check_mysqldb/ver.1.0/
    cp -R ~/sh_tool/log/   /root/scripts/check_mysqldb/ver.1.0/
 
-DEPENDENCIES
+Or You can use Docker to create image/container.
+
+|GitHub docker checker|
+
+.. |GitHub docker checker| image:: https://github.com/vroncevic/check_mysqldb/workflows/check_mysqldb%20docker%20checker/badge.svg
+   :target: https://github.com/vroncevic/check_mysqldb/actions?query=workflow%3A%22check_mysqldb+docker+checker%22
+
+Dependencies
 -------------
 
 **check_mysqldb** requires next modules and libraries:
     sh_util `https://github.com/vroncevic/sh_util <https://github.com/vroncevic/sh_util>`_
 
-SHELL TOOL STRUCTURE
+Shell tool structure
 ---------------------
 
 **check_mysqldb** is based on MOP.
@@ -66,7 +78,7 @@ Shell tool structure:
    └── log/
        └── check_mysqldb.log
 
-COPYRIGHT AND LICENCE
+Copyright and licence
 ----------------------
 
 |License: GPL v3| |License: Apache 2.0|
@@ -79,7 +91,7 @@ COPYRIGHT AND LICENCE
 
 Copyright (C) 2016 by `vroncevic.github.io/check_mysqldb <https://vroncevic.github.io/check_mysqldb>`_
 
-This tool is free software; you can redistribute it and/or modify it
+**check_mysqldb** is free software; you can redistribute it and/or modify it
 under the same terms as Bash itself, either Bash version 4.2.47 or,
 at your option, any later version of Bash 4 you may have available.