tylerjrichards / st-paywall

A python package for creating subscription Streamlit apps
MIT License
266 stars 52 forks source link

Documentation #15

Closed sebastiandres closed 1 year ago

sebastiandres commented 1 year ago

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:

tylerjrichards commented 1 year ago

this is a really great idea, would love to help with a PR on this!

sebastiandres commented 1 year ago

OK, I'll fork and setup the documentation files!

tylerjrichards commented 1 year ago

closing this as we merged the PR today