As the project seems to be growing quickly, the README file soon will be too large to contain all the explanations.
I would suggest (and volunteer) to create a readthedocs documentation, that is actually not so hard to maintain.
See as an example a previous pet project: https://streamlit-book.readthedocs.io/en/latest/
The documentation should live on the same repo project and get's updated automatically when the main branch of the repo is updated.
As the project seems to be growing quickly, the README file soon will be too large to contain all the explanations. I would suggest (and volunteer) to create a readthedocs documentation, that is actually not so hard to maintain. See as an example a previous pet project: https://streamlit-book.readthedocs.io/en/latest/
The documentation should live on the same repo project and get's updated automatically when the main branch of the repo is updated.
Outline: