updated docs

README.md

@@ -11,7 +11,10 @@ This repo contains an experimental framework for automating the workflow of an a
 
 You can read more about some of my thoughts [here](https://holdmybeer.io/2024/06/04/ham-stack-modernizing-the-wheel/), which may or may not be in sync with this repo. ¯\\\_(ツ)\_/¯ But they may explain some of the insanity behind this well-intentioned effort.
 
-And it probably goes without saying.. feedback is very welcome.
+Further reading:
+
+- [Details on API](api/README.md)
+- [Details on CLI](cli/README.md)
 
 ## Repo layout
 

api/README.md

@@ -20,8 +20,7 @@ If _section_ is not specified in the API call, the operation will assume _sectio
 
 ## Using the API
 
-The API is implemented as a Docker container running gunicorn/uvicorn/[FastAPI](https://fastapi.tiangolo.com/).  By default, the API will open 65432/tcp. 
-
+The API is implemented as a Docker container running [FastAPI](https://fastapi.tiangolo.com/).  By default, the API will open 65432/tcp.
 
 ### Container
 
@@ -65,6 +64,12 @@ and optionally you can pass environment variables like
     python api.py
 ```
 
+## Testing
+
+/tests contains the [pytest](https://docs.pytest.org/en/stable/) testing framework [integrated with FastAPI](https://fastapi.tiangolo.com/tutorial/testing/) and will be expanded over time. Currently, this has to be run manually from repo root with 'pytest' and has poor coverage.
+
+You can find the beginnings in [/tests/test_api.py](../tests/test_api.py).
+
 ## OpenAPI docs
 
 FastAPI is self-documenting as [OpenAPI](https://www.openapis.org/) (the artist formerly known as Swagger), which can be found at

doc/README.md → cli/README.md

@@ -1,5 +1,7 @@
 ## **Operation**
 
+# _OUT OF DATE_
+
 ### CLI
 
 The directory _cli/_ contains the instructions and contents for building a [Docker](https://docker.io) container to contain and execute CLI commands to interact with the services.  It is also used to bootstrap the configuration.