add examples and improve docs

[ahmadtourei]

This PR improves the README and adds some examples.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.40%. Comparing base (3619873) to head (913e3d3).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #17   +/-   ##
=======================================
  Coverage   92.40%   92.40%           
=======================================
  Files          13       13           
  Lines         685      685           
=======================================
  Hits          633      633           
  Misses         52       52           

Flag	Coverage Δ
python-3.10	92.40% <ø> (ø)
python-3.11	92.40% <ø> (ø)
python-3.12	92.40% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.