Update README.md and why.md

README.md

@@ -106,19 +106,22 @@ Don't want to write any code? Simply pass any Python script to `arguably` to giv
 </sub></div>
 
 ```console
-user@machine:~$ python3 -m arguably party-trick.py
-usage: party-trick [-h] command ...
+user@machine:~$ python3 -m arguably etc/scripts/party-trick.py -h
+usage: party-trick [-h] [--version] command ...
+
+this is the docstring for the whole script
 
 positional arguments:
   command
-    hello                this is the docstring for a function in the script
-    goodbye              any function from a script can be called
-    a-class              so can any __init__ for objects defined in the script
-    a-class.func-static  a @staticmethod on a class can be called
-    a-class.func-cls     so can a @classmethod
+    hello                   this is hello's docstring
+    goodbye                 any function from a script can be called
+    some-class              so can any __init__ for objects defined in the script
+    some-class.func-static  a @staticmethod on a class can be called
+    some-class.func-cls     so can a @classmethod
 
 options:
-  -h, --help             show this help message and exit
+  -h, --help                show this help message and exit
+  --version                 show program's version number and exit
 ```
 
 ## Installation
@@ -128,6 +131,7 @@ Install using `pip install arguably`. If you want to install using `conda`, plea
 
 ## Documentation
 
+* Why arguably?: [https://treykeown.github.io/arguably/why/](https://treykeown.github.io/arguably/why/)
 * Examples: [https://treykeown.github.io/arguably/examples/](https://treykeown.github.io/arguably/examples/)
 * Tutorial: [https://treykeown.github.io/arguably/tutorial/intro/](https://treykeown.github.io/arguably/tutorial/intro/)
 * API Reference: [https://treykeown.github.io/arguably/api-reference/](https://treykeown.github.io/arguably/api-reference/)
@@ -153,4 +157,5 @@ If you have any interest in these (either as a user or implementer), please leav
 * [#8 - Display all enum options in a command group](https://github.com/treykeown/arguably/issues/8)
 * [#9 - Both positive and negative boolean flags](https://github.com/treykeown/arguably/issues/9)
 * [#10 - Take inputs from environment variables](https://github.com/treykeown/arguably/issues/10)
-* [#13 - Load configuration for a script via a `.yml`](https://github.com/treykeown/arguably/issues/13)
+* [#13 - Implement config interface](https://github.com/treykeown/arguably/issues/13)
+* [#16 - Integration with rich for formatted CLI output](https://github.com/treykeown/arguably/issues/16)

docs/why.md

@@ -158,8 +158,8 @@ A quick comparison with a `typer` CLI is below. This is taken from the
 [`databooks` project](https://github.com/datarootsio/databooks).
 
 !!! warning
-    The design for the config interface shown here for `arguably` isn't yet finalized. Development is tracked in
-    [https://github.com/treykeown/arguably/issues/13](https://github.com/treykeown/arguably/issues/13).
+    The design for the config interface shown here for `arguably` isn't yet finalized and is still being implemented.
+    Development is tracked in [https://github.com/treykeown/arguably/issues/13](https://github.com/treykeown/arguably/issues/13).
 
 ### The `typer` implementation
 

etc/pypi/PYPI_README.md

@@ -103,19 +103,22 @@ Don't want to write any code? Simply pass any Python script to `arguably` to giv
 </sub></div>
 
 ```console
-user@machine:~$ python3 -m arguably party-trick.py
-usage: party-trick [-h] command ...
+user@machine:~$ python3 -m arguably etc/scripts/party-trick.py -h
+usage: party-trick [-h] [--version] command ...
+
+this is the docstring for the whole script
 
 positional arguments:
   command
-    hello                this is the docstring for a function in the script
-    goodbye              any function from a script can be called
-    a-class              so can any __init__ for objects defined in the script
-    a-class.func-static  a @staticmethod on a class can be called
-    a-class.func-cls     so can a @classmethod
+    hello                   this is hello's docstring
+    goodbye                 any function from a script can be called
+    some-class              so can any __init__ for objects defined in the script
+    some-class.func-static  a @staticmethod on a class can be called
+    some-class.func-cls     so can a @classmethod
 
 options:
-  -h, --help             show this help message and exit
+  -h, --help                show this help message and exit
+  --version                 show program's version number and exit
 ```
 
 ## Installation
@@ -125,6 +128,7 @@ Install using `pip install arguably`. If you want to install using `conda`, plea
 
 ## Documentation
 
+* Why arguably?: [https://treykeown.github.io/arguably/why/](https://treykeown.github.io/arguably/why/)
 * Examples: [https://treykeown.github.io/arguably/examples/](https://treykeown.github.io/arguably/examples/)
 * Tutorial: [https://treykeown.github.io/arguably/tutorial/intro/](https://treykeown.github.io/arguably/tutorial/intro/)
 * API Reference: [https://treykeown.github.io/arguably/api-reference/](https://treykeown.github.io/arguably/api-reference/)
@@ -150,4 +154,5 @@ If you have any interest in these (either as a user or implementer), please leav
 * [#8 - Display all enum options in a command group](https://github.com/treykeown/arguably/issues/8)
 * [#9 - Both positive and negative boolean flags](https://github.com/treykeown/arguably/issues/9)
 * [#10 - Take inputs from environment variables](https://github.com/treykeown/arguably/issues/10)
-* [#13 - Load configuration for a script via a `.yml`](https://github.com/treykeown/arguably/issues/13)
+* [#13 - Implement config interface](https://github.com/treykeown/arguably/issues/13)
+* [#16 - Integration with rich for formatted CLI output](https://github.com/treykeown/arguably/issues/16)