update docs

Author: gavinlyonsrepo

README.md

@@ -17,7 +17,7 @@ Table of contents
   * [Installation](#installation)
   * [Usage](#usage)
   * [Software](#software)
-  * [Demo](#demo)
+  * [Example](#example)
 
 Installation
 -----------------------------------------------
@@ -55,7 +55,7 @@ It's also available in the Arch Linux user repo AUR
 Usage
 -------------------------------------------
 
-Source the library from your bash shell scripts like so:
+Source the library functions from your bash shell scripts like so:
 
 ```sh
 LIBPATH="/usr/lib/bashmultitool/"
@@ -65,26 +65,21 @@ do
 done
 ```
 
-There are eight files in library and they are independent of each other
-you can source them individually if you wish, however the prompt file *is* 
-dependent on print. Each file has one function, To access functions from your shell scripts type:
+To access library functions from your shell scripts type:
 
 ```sh
-[function-name] [keyword] [options]
- 
-[section] [sub-section] [options]
-```
+# [function-name] [keyword] [options]
+# eg
+
+bmtPrintFunc b_red "Hello World"
+ ```
 
 Software
 -----------------------------------------
 
 Eight separate markdown help files with detailed information, 
 in documentation folder are available.
-For shortcut to each help file click on link in 2nd table in *software* section below.
-
-The repo also contains a *test folder* where test files used in development are available,
-one for each library file.
-
+For shortcut to each help file click on link in 2nd table in *software* section below. The repo also contains a *test folder* where test files used in development are available, one for each library file.
 A script to print library meta data is also installed.
 
 | Installed File Path | Description |
@@ -105,13 +100,18 @@ A script to print library meta data is also installed.
 |  bmtTime | btmTimeFunc | 701-709 | Time related | [bmtTime help file](documentation/bmtTime.md)|
 |  bmtMisc  | bmtMiscFunc  | 801-804 | Miscellaneous | [bmtMisc help file](documentation/bmtMisc.md)|
 
-The library contains eight section's, Each section has one file with one function.
-which contains 43 sub-sections in total.
+The library contains eight section's, Each section has one file with one function. 
+Which contains 50 sub-sections in total.
 The sections are grouped per logical function.
 Printing, prompting, Linux related, file related, 
 data related, time related , network related and miscellaneous.
+The sections are mostly independent of each other
+you can source them individually if you wish, however the prompt file *is* 
+dependent on print. Each file has one function,
 
-Output
+Example
 ----------------------------
 
+Output of basic example file in example folder, showing basic usage.
+
 ![ScreenShot](https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/documentation/screenshot/example.png)

documentation/bmtPrompt.md

@@ -24,8 +24,8 @@ Keyword is line, first option the character, second option is colour,
 if no colour passed default is "bold cyan"
 
 ```sh
-	bmtPromptFunc line    "=" 
-	bmtPromptFunc line    "8" red
+bmtPromptFunc line    "=" 
+bmtPromptFunc line    "8" red
 ```
 
 202) yes-no-quit prompt y/n/q
@@ -92,8 +92,9 @@ bmtPromptFunc quitno no
 Returns 0 for no , 2 for quit , 50 for bad user option
 
 208)  Wish to continue loop prompt 
-Exits program if user presses N , continues if user presses yes
-Message optional and custom.
+Exits program if user presses N , continues if user presses yes.
+Param1 Message Custom. Param2 is colour,
+if no colour passed default is "bold cyan"
 
 ```sh
 bmtPromptFunc wishtocontinue "Do you wish to contine?"
@@ -106,6 +107,10 @@ bmtPromptFunc centertext "Hello World."
 
 210) Print an event status , Installing bashMultiTool ...... [OK]
 
+* Param 1 text on  left 
+* Param 2 text on right
+* Param 3 colour , if no colour passed default is "bold cyan"
+
 ```sh
 bmtPromptFunc eventstatus "Installing bashMultiTool" "OK" 
 ````

documentation/bmtTime.md

@@ -79,3 +79,10 @@ percentage completed.
 	sleep 2
 	echo " "
 ```
+
+709) Convert Epoch time to date format
+
+```sh
+bmtTimeFunc dateformat "1651084921" "%FT%T%z"
+# prints ~ 2022-04-27T19:42:01+0100
+```