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:

• [x] 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[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

Additional details and impacted files

[](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/299?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) ```diff @@ 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](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/299?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/299?dropdown=coverage&src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). Last update [baa4ff2...df565c3](https://app.codecov.io/gh/ordo-one/package-benchmark/pull/299?dropdown=coverage&src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ordo-one).

[github-actions[bot]]

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