Merge pull request #2357 from Bash-it/feature/bash5-as-baseline

Author: seefood

docs/README.md

@@ -5,13 +5,17 @@
 ![License](https://img.shields.io/github/license/Bash-it/bash-it)
 ![shell](https://img.shields.io/badge/Shell-Bash-blue)
 
-**Bash-it** is a collection of community Bash commands and scripts for Bash 3.2+.
+**Bash-it** is a collection of community Bash commands and scripts for Bash.
 (And a shameless ripoff of [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) :smiley:)
+97% of the code is compatible with bash 3.2+ but we are geared also toward power users,
+and one or two of the more complex plugins may need bash 5 features to run. If you
+happen to be "stuck" on an older version of bash, we have code in place to prevent you
+from running those modules and getting errors. It's a short list though, and none of the core code.
 
 Includes autocompletion, themes, aliases, custom functions, a few stolen pieces from Steve Losh, and more.
 
 Bash-it provides a solid framework for using, developing and maintaining shell scripts and custom commands for your daily work.
-If you're using the _Bourne Again Shell_ (Bash) regularly and have been looking for an easy way on how to keep all of these nice little scripts and aliases under control, then Bash-it is for you!  
+If you're using the _Bourne Again Shell_ (Bash) regularly and have been looking for an easy way on how to keep all of these nice little scripts and aliases under control, then Bash-it is for you!
 Stop polluting your `~/bin` directory and your `.bashrc` file, fork/clone Bash-it and start hacking away.
 
 - [Main Page](https://bash-it.readthedocs.io/en/latest)
@@ -42,9 +46,9 @@ Stop polluting your `~/bin` directory and your `.bashrc` file, fork/clone Bash-i
    ``git clone --depth=1 https://github.com/Bash-it/bash-it.git ~/.bash_it``
 2) Run ``~/.bash_it/install.sh``
 
-That's it! :smiley:  
+That's it! :smiley:
 
-You can check out more components of Bash-it, and customize it to your desire.  
+You can check out more components of Bash-it, and customize it to your desire.
 For more information, see detailed instructions [here](https://bash-it.readthedocs.io/en/latest/installation/).
 
 ### custom configuration file location

docs/contributing.rst

@@ -47,8 +47,12 @@ Code Style
   Take a look at the existing code for an example (e.g. `the base plugin <plugins/available/base.plugin.bash>`_\ ).
 * When adding files, please use the existing file naming conventions, e.g. plugin files need to end in ``.plugin.bash``.
   This is important for the installation functionality.
-* When using the ``$BASH_IT`` variable, please always enclose it in double quotes to ensure that the code also works when Bash-it is installed in a directory that contains spaces in its name: ``for f in "${BASH_IT}/plugins/available"/*.bash ; do echo "$f" ; done``
+* When using the ``$BASH_IT`` variable, please always enclose it in double quotes to ensure that the code also works when
+  Bash-it is installed in a directory that contains spaces in its name: ``for f in "${BASH_IT}/plugins/available"/*.bash ; do echo "$f" ; done``
 * Bash-it supports Bash 3.2 and higher. Please don't use features only available in Bash 4, such as associative arrays.
+* That said, if you have a really cool plugin or feature to contribute and it absolutely too slow or hard to implement
+  without bash4 or higher, please see plugins/available/pack.plugin.bash for an example how to self disable and log the reason
+  so bash 3.2 users are not stuck with errors that don't need to handle.
 
 Unit Tests
 ----------