Is your feature request related to a problem? Please describe.
The README.md has some examples (mostly for Maybe) but not much for the other types.
Describe the solution you'd like
It would be nice to provide simple examples for all the types/methods and a couple more complex use-cases.
Describe alternatives you've considered
This is somewhat covered by tests, but I'd like to have concrete documentation/examples outside of the tests, which are less about teaching and more to prevent regressions.
We could also link to markdown files for each type if the README.md gets too long and hard to navigate. One benefit of having the examples in the README.md is that it auto populates the description on npm.
Is your feature request related to a problem? Please describe. The
README.md
has some examples (mostly forMaybe
) but not much for the other types.Describe the solution you'd like It would be nice to provide simple examples for all the types/methods and a couple more complex use-cases.
Describe alternatives you've considered This is somewhat covered by tests, but I'd like to have concrete documentation/examples outside of the tests, which are less about teaching and more to prevent regressions.
We could also link to markdown files for each type if the
README.md
gets too long and hard to navigate. One benefit of having the examples in theREADME.md
is that it auto populates the description on npm.Additional context n/a