update_readme

[yanzastro]

Problem & Solution Description (including issue #)

Code Quality

• My code follows the code style of this project
• I have written unit tests or justified all instances of #pragma: no cover; in the case of a bugfix, a new test that breaks as a result of the bug has been added
• My code contains relevant comments and necessary documentation for future maintainers; the change is reflected in applicable demos/tutorials (with output cleared!) and added/updated docstrings use the NumPy docstring format
• Any breaking changes, described above, are accompanied by backwards compatibility and deprecation warnings

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (b455da8) to head (412f0c3).

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #16   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          322       322           
=========================================
  Hits           322       322           

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