Where are the docs?

[BoxingLaunch]

Can you add a link to the documentation in the README and on the PyPi page please

[bgreen-litl]

The README is the docs. It made sense at first to just provide simple examples as the documentation. The simple examples still work, but at this point there's enough details and nuance that there should be separate documentation, perhaps hosted at readthedocs. The README can then become more of an installation, development, quickstart document.

[ranggakd]

The README is the docs. It made sense at first to just provide simple examples as the documentation. The simple examples still work, but at this point there's enough details and nuance that there should be separate documentation, perhaps hosted at readthedocs. The README can then become more of an installation, development, quickstart document.

I would support readthedocs at this point.

[DeflateAwning]

An example of something that docs should cover is all the different types of "wait generator" functions. There's a few, and they all have their own kwargs that can be passed to them, so it would be great to store those in one place to keep track of them

[edgarrmondragon]

The README is the docs. It made sense at first to just provide simple examples as the documentation. The simple examples still work, but at this point there's enough details and nuance that there should be separate documentation, perhaps hosted at readthedocs. The README can then become more of an installation, development, quickstart document.

@bgreen-litl do you have any preferences for docs tool (e.g. Sphinx vs Mkdocs). I think I can send a PR your way to at least set up local development with a few pages. Wdyt?