Provide reference and basic usage in README

[dave08]

The TestResource and ProjectExtension are hidden in assertions-fx which is not really clear for a new user to guess that they exist. How to use them and their purpose could also be explained shortly there, for newer users that find the implementations to complex to grasp.

Perhaps a list of assertions would also be nice...

Those two classes are not assertions, so maybe they should be in a separate dependency? And anyways, there are many that don't use Kotest assertions (like those that use Strikt instead), so these classes would be importable without dragging along possibly unused assertions. (like a io.kotest.extensions:kotest-extension-arrow:_ dependency.

The docs in https://kotest.io/docs/assertions/arrow.html should maybe include the full list of assertions, and there could be an entry in https://kotest.io/docs/extensions/extensions.html for the extension.

[i-walker]

We posted a release for them https://www.47deg.com/blog/kotest-arrow-extension-v1-03-0-release/, but we're working on adding more docs on the kotest website. I've been mostly occupied, after the 1.3.0 release, but will start mid-end of February with this

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.