Add usage instructions (#13)

* Add usage instructions

* Add usage in gif

* Add NO_COLOR usage in README.md

* Update README description and keencli.gif

* Add badges and help info for format flag

* Skip markdownlint ```Inline HTML``` errors

README.md

@@ -1,6 +1,33 @@
+<!-- markdownlint-disable -->
+<div align='center'>
+<!-- markdownlint-enable -->
+
 # keencli
 
-Bash script to control Keenetic routers via HTTP API.
+Bash script to control Keenetic routers via HTTP API
+
+[
+![version](https://img.shields.io/github/v/release/tolkonepiu/keencli?label=version)
+](https://github.com/tolkonepiu/keencli/releases/latest)
+[
+![license](https://img.shields.io/github/license/tolkonepiu/keencli)
+](LICENSE)
+[
+![linters](https://github.com/tolkonepiu/keencli/actions/workflows/linters.yml/badge.svg?branch=main)
+](https://github.com/tolkonepiu/keencli/actions/workflows/linters.yml?query=branch%3Amain)
+[
+![tests](https://github.com/tolkonepiu/keencli/actions/workflows/tests.yml/badge.svg?branch=main)
+](https://github.com/tolkonepiu/keencli/actions/workflows/tests.yml?query=branch%3Amain)
+
+---
+
+[![keencli](keencli.gif)](https://asciinema.org/a/612771?autoplay=1)
+
+---
+
+<!-- markdownlint-disable -->
+</div>
+<!-- markdownlint-enable -->
 
 ## Requirements
 
@@ -55,6 +82,12 @@ To turn on debugging output:
 DEBUG=1 keencli <command> <subcommand>
 ```
 
+To turn off color output:
+
+```sh
+NO_COLOR=1 keencli <command> <subcommand>
+```
+
 ## Development
 
 keencli uses [bashly](https://github.com/DannyBen/bashly/) for generating

keencli

@@ -109,7 +109,7 @@ keencli_request_usage() {
 
     # :flag.usage
     printf "  %s\n" "--format, -f FORMAT"
-    printf "\n"
+    printf "    Output format type\n"
     printf "    Allowed: json, yaml, xml, props\n"
     echo
 
@@ -213,7 +213,7 @@ keencli_show_system_usage() {
 
     # :flag.usage
     printf "  %s\n" "--format, -f FORMAT"
-    printf "\n"
+    printf "    Output format type\n"
     printf "    Allowed: json, yaml, xml, props\n"
     printf "    Default: yaml\n"
     echo
@@ -270,7 +270,7 @@ keencli_show_interface_usage() {
 
     # :flag.usage
     printf "  %s\n" "--format, -f FORMAT"
-    printf "\n"
+    printf "    Output format type\n"
     printf "    Allowed: json, yaml, xml, props\n"
     printf "    Default: yaml\n"
     echo
@@ -365,7 +365,7 @@ keencli_show_ip_hotspot_usage() {
 
     # :flag.usage
     printf "  %s\n" "--format, -f FORMAT"
-    printf "\n"
+    printf "    Output format type\n"
     printf "    Allowed: json, yaml, xml, props\n"
     printf "    Default: yaml\n"
     echo
@@ -421,7 +421,7 @@ keencli_show_internet_usage() {
 
     # :flag.usage
     printf "  %s\n" "--format, -f FORMAT"
-    printf "\n"
+    printf "    Output format type\n"
     printf "    Allowed: json, yaml, xml, props\n"
     printf "    Default: yaml\n"
     echo

src/bashly.yml

@@ -54,6 +54,7 @@ commands:
       - long: --format
         short: -f
         arg: format
+        help: Output format type
         allowed:
           - json
           - yaml
@@ -82,6 +83,7 @@ commands:
             long: --format
             short: -f
             arg: format
+            help: Output format type
             default: yaml
             allowed:
               - json