README update

[kubagalecki]

• README now contains some useful documentation
• added examples to CI

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.79%. Comparing base (8be088b) to head (997dff7).

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #60      +/-   ##
==========================================
- Coverage   93.88%   93.79%   -0.09%     
==========================================
  Files          95       95              
  Lines        5724     5724              
  Branches     2543     2543              
==========================================
- Hits         5374     5369       -5     
- Misses         72       73       +1     
- Partials      278      282       +4     

see 2 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

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