improve the documentation of the action

[keewis]

So far the documentation was pretty minimal: a simple example, no explanation of the options, no real-world examples.

• closes Link to example issues from readme ? #20

[keewis]

cc @jrbourbeau, I hope you don't mind me using dask as an example

[jrbourbeau]

No problem at all! Only suggestion would be to point to an already closed issue : )

[jrbourbeau]

Btw, I wrote a short blogpost about how we're using this over in the Dask / Coiled blogs that give you a shoutout https://blog.dask.org/2023/04/18/dask-upstream-testing. I can't remember if I sent you this already or not -- hope that's okay

[keewis]

I don't remember whether you pinged me regarding that, but I do remember reading that blog post and being happy that the action is useful for other people. In other words, yes, that's totally okay!