feat: add improved example project

[jeroen-meijer]

Description

This PR adds an example project that showcases how to test a pair of example widgets.

The example.md file is preserved (with some minor change). This way, users on pub.dev will still see a single example file, but may also consult the full example project if they wish.

Type of Change

• ✨ New feature (non-breaking change which adds functionality)
• 🛠️ Bug fix (non-breaking change which fixes an issue)
• ❌ Breaking change (fix or feature that would cause existing functionality to change)
• 🧹 Code refactor
• ✅ Build configuration change
• 📝 Documentation
• 🗑️ Chore

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (main@c55200c). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             main       #57   +/-   ##
========================================
  Coverage        ?   100.00%           
========================================
  Files           ?        12           
  Lines           ?       506           
  Branches        ?         0           
========================================
  Hits            ?       506           
  Misses          ?         0           
  Partials        ?         0           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c55200c...418a92c. Read the comment docs.

[marcossevilla]

lgtm, just a comment regarding changelog

[marcossevilla]

can we remove this changelog part? we can address that on #53

[jeroen-meijer]

Good catch. Will do!

[Kirpal]

This is all good, but it would be nice to see some more advanced use cases being tested, such as tapping, injecting app theme/localizations, loading images, etc. What do you think? I don't mind adding that if you'd like me to.

[alestiago]

@Kirpal maybe we can have more than one example, similar to how it's being done in the bloc library.

Thus, if one is not interested in learning about advanced use cases and only wants to know how to get started they can select a simpler example.

[jeroen-meijer]

Agreed with @Kirpal and @alestiago on this one.

I can rename this "simple_example" which allows us the opportunity to add more complex ones in the future. How does that sound?

PS: @Kirpal you can then add more examples in a separate PR if you'd like :)

[Kirpal]

That sounds good to me! @jeroen-meijer @alestiago

[jeroen-meijer]

Will get to this tomorrow! :)

[marcossevilla]

@jeroen-meijer are we adding this simple example and then the complex one in a separate PR? just to see if we can approve/merge this one

[jeroen-meijer]

I guess we can do the rename later.

Sorry I haven't gotten to this yet, got swamped with other stuff :/
I say we merge this and do the more complex example and the rename later @marcossevilla 👍🏻

[marcossevilla]

I guess we can do the rename later.

Sorry I haven't gotten to this yet, got swamped with other stuff :/ I say we merge this and do the more complex example and the rename later @marcossevilla 👍🏻

no worries! lgtm 🚀