docs: Update readme to fix broken example benchmark

[lehtihet]

Description

Updates readme to fix the broken benchmark example, fixes #295 which contains more information.

How Has This Been Tested?

Tested running the benchmark from an empty project.

Minimal checklist:

• I have performed a self-review of my own code
• I have added DocC code-level documentation for any public interfaces exported by the package
• I have added unit and/or integration tests that prove my fix is effective or that my feature works

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.44%. Comparing base (baa4ff2) to head (df565c3).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #299   +/-   ##
=======================================
  Coverage   71.44%   71.44%           
=======================================
  Files          32       32           
  Lines        3788     3788           
=======================================
  Hits         2706     2706           
  Misses       1082     1082           

---

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 baa4ff2...df565c3. Read the comment docs.

[github-actions]

Pull request had an unknown failure
Pull request benchmark comparison [ubuntu-latest] with 'main' run at 2024-11-12T13:27:27+00:00