update examples

Author: DannyBen

examples/catch-all-advanced/README.md

@@ -1,6 +1,15 @@
 # Catch All Advanced Example
 
-Demonstrates the advanced form of `catch_all`, where you can specify a help message .
+Demonstrates the advanced form of `catch_all`, where you can specify a help
+message.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly generate
+```
 
 -----
 
@@ -51,6 +60,8 @@ commands:
     required: true
 ```
 
+
+
 ## Generated script output
 
 ### `$ ./cli`

examples/catch-all/README.md

@@ -3,6 +3,14 @@
 Demonstrates the use of the `catch_all` option, which will allows any command
 to receive an arbitrary list of arguments.
 
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly generate
+```
+
 -----
 
 ## `bashly.yml`
@@ -21,6 +29,8 @@ args:
   help: Message
 ```
 
+
+
 ## Generated script output
 
 ### `$ ./download`

examples/colors/README.md

@@ -1,17 +1,26 @@
-Colors Example
-==================================================
+# Colors Example
 
-This example was generated with:
+This example demonstrates how to add color print functions.
 
-    $ bashly init
-    $ bashly add colors
-    $ bashly generate
+This example was generated with:
 
-The `bashly add colors` command, simply created the [src/lib/colors.sh](src/lib/colors.sh) file, with useful color functions that will be automatically included in the generated script.
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly add colors
+$ bashly generate
+# ... now edit src/root_command.sh ...
+$ bashly generate
+```
 
+The `bashly add colors` command, simply created the [src/lib/colors.sh]
+(src/lib/colors.sh) file, with useful color functions that will be
+automatically included in the generated script.
 
+See the manually edited [src/root_command.sh](src/root_command.sh) for usage
+examples.
 
-See the manually edited [src/root_command.sh](src/root_command.sh) for usage examples.
+<!-- include: src/root_command.sh -->
 
 -----
 
@@ -27,6 +36,21 @@ args:
   help: "Message to show [default: hello colors]"
 ```
 
+## `src/root_command.sh`
+
+```bash
+message=${args[message]:-hello colors}
+
+underlined "Message Recevied":
+echo
+echo "  => $(green_bold "$message")"
+echo "  ==> $(red_bold "$message")"
+echo "  ===> $(blue_bold "$message")"
+echo
+
+```
+
+
 ## Generated script output
 
 ### `$ ./colorly`

examples/command-default/README.md

@@ -1,6 +1,15 @@
 # Default Command Example
 
-Demonstrates how to set a command as the default command. This command can be executed without explicitly specifying the command name.
+Demonstrates how to set a command as the default command. This command can be
+executed without explicitly specifying the command name.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly generate
+```
 
 -----
 
@@ -36,6 +45,8 @@ commands:
     help: File to download
 ```
 
+
+
 ## Generated script output
 
 ### `$ ./ftp`

examples/command-groups/README.md

@@ -1,6 +1,16 @@
 # Command Groups Example
 
-Demonstrates how to visually group commands under their own caption. This is useful for scripts that contain many commands that provide different sets of functionality.
+Demonstrates how to visually group commands under their own caption. This is
+useful for scripts that contain many commands that provide different sets of
+functionality.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly generate
+```
 
 -----
 
@@ -44,6 +54,8 @@ commands:
   help: Delete login credentials to the config file
 ```
 
+
+
 ## Generated script output
 
 ### `$ ./ftp`

examples/commands-nested/README.md

@@ -4,8 +4,11 @@ Demonstrates how to commands can be nested inside other commands.
 
 This example was generated with:
 
-    $ bashly init
-    $ bashly generate
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly generate
+```
 
 -----
 
@@ -61,6 +64,8 @@ commands:
     args: *file_args   # reuse args from the show command
 ```
 
+
+
 ## Generated script output
 
 ### `$ ./cli`

examples/commands/README.md

@@ -4,8 +4,10 @@ Demonstrates how to build a script that supports sub-commands.
 
 This example was generated with:
 
-    $ bashly init
-    $ bashly generate
+```bash
+$ bashly init
+$ bashly generate
+```
 
 -----
 
@@ -67,6 +69,8 @@ commands:
     help: Password to use for logging in
 ```
 
+
+
 ## Generated script output
 
 ### `$ ./cli`

examples/completions/README.md

@@ -4,9 +4,16 @@ Demonstrates how to build a script that supports bash completions.
 
 This example was generated with:
 
-    $ bashly init
-    $ bashly add comp function
-    $ bashly generate
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly add comp function
+$ bashly generate
+# ... now edit src/completions_command.sh ...
+$ bashly generate
+```
+
+<!-- include: src/completions_command.sh -->
 
 -----
 
@@ -72,6 +79,22 @@ commands:
     help: Password to use for logging in
 ```
 
+## `src/completions_command.sh`
+
+```bash
+# Call the `send_completions` function which was added by running:
+#
+#   $ bashly add comp function
+#
+# Users can now enable bash completion for this script by running:
+#
+#   $ eval "$(cli completions)"
+#
+send_completions
+
+```
+
+
 ## Generated script output
 
 ### `$ ./cli`

examples/config-ini/README.md

@@ -1,15 +1,24 @@
 # Config Example
 
+Demonstrates how to add functions for reading and writing INI files.
+
 This example was generated with:
 
-    $ bashly init
-    $ bashly add config
-    $ bashly generate
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly add config
+$ bashly generate
+# ... now edit all files in the src folder ...
+$ bashly generate
+```
 
 Running the `bashly add config` command simply added the [src/lib/config.sh](src/lib/config.sh) file, which includes functions for reading and writing values from an INI file.
 
 See the files in the [src](src) folder for usage examples.
 
+<!-- include: config.ini src/get_command.sh src/list_command.sh src/set_command.sh -->
+
 -----
 
 ## `bashly.yml`
@@ -52,6 +61,58 @@ commands:
   help: Show the entire config file
 ```
 
+## `config.ini`
+
+```ini
+; comments are allowed
+hello = world
+bashly = works
+
+
+```
+
+## `src/get_command.sh`
+
+```bash
+# Using the standard library (lib/config.sh) to show a value from the config
+
+key="${args[key]}"
+if config_has_key "$key" ; then 
+  config_get "$key"
+else
+  echo "No such key: $key"
+fi
+
+# Example of how to assign the config value to a variable:
+# result=$(config_get "${args[key]}")
+# echo $result
+
+
+```
+
+## `src/list_command.sh`
+
+```bash
+# Using the standard library (lib/config.sh) to show the entire config file
+config_show
+
+# Or to iterate through keys
+for key in $(config_keys) ; do
+  echo "$key === $(config_get "$key")"
+done
+
+```
+
+## `src/set_command.sh`
+
+```bash
+# Using the standard library (lib/config.sh) to store a value to the config
+config_set "${args[key]}" "${args[value]}"
+echo "saved: ${args[key]} = ${args[value]}"
+
+```
+
+
 ## Generated script output
 
 ### `$ ./configly -h`