docs: document new features

[vbreuss]

Updates Mockolate’s user-facing documentation to cover newly added verification waiting options, setup-specific verification, and HttpClient convenience return helpers, aligning README and Docs pages with the latest API surface.

Changes:

• Document Within(TimeSpan) and WithCancellation(CancellationToken) for waiting on verifications
  feat: add Within and WithCancellation to verification result #496
• Add documentation for verifying invocations of a specific method setup via InvokedSetup(setup)
  feat: allow verifying method setup calls #493
• Document HttpClient .ReturnsAsync(HttpStatusCode, ...) overloads for simplified response setup
  feat: simplify specifying the return value of HttpClient setup methods #497

[Copilot]

Pull request overview

Updates Mockolate’s user-facing documentation to cover newly added verification waiting options, setup-specific verification, and HttpClient convenience return helpers, aligning README and Docs pages with the latest API surface.

Changes:

• Document Within(TimeSpan) and WithCancellation(CancellationToken) for waiting on verifications.
• Add documentation for verifying invocations of a specific method setup via InvokedSetup(setup).
• Document HttpClient .ReturnsAsync(HttpStatusCode, ...) overloads for simplified response setup.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
README.md	Adds docs for verification waiting (Within/WithCancellation), setup verification (InvokedSetup), and HttpClient .ReturnsAsync overload examples.
Docs/pages/special-types/01-httpclient.md	Adds a “Return Message” section documenting .ReturnsAsync(HttpStatusCode, ...) overloads with examples.
Docs/pages/04-verify-interactions.md	Adds docs for Within/WithCancellation and for verifying specific setups via InvokedSetup.

[github-actions]

Test Results

    21 files  ±0      21 suites  ±0   5m 38s ⏱️ +9s
 2 796 tests ±0   2 795 ✅ ±0  1 💤 ±0  0 ❌ ±0 
18 789 runs  ±0  18 788 ✅ ±0  1 💤 ±0  0 ❌ ±0 

Results for commit 8357f92. ± Comparison against base commit c95953c.

[github-actions]

🚀 Benchmark Results

Details

BenchmarkDotNet v0.15.8, Linux Ubuntu 24.04.3 LTS (Noble Numbat)

AMD EPYC 7763 2.89GHz, 1 CPU, 4 logical and 2 physical cores

.NET SDK 10.0.103

[Host] : .NET 10.0.3 (10.0.3, 10.0.326.7603), X64 RyuJIT x86-64-v3
Job=InProcess  Toolchain=InProcessEmitToolchain  IterationCount=15

LaunchCount=1  WarmupCount=10

Method	Mean	Error	StdDev	Gen0	Gen1	Allocated
Simple_Mockolate	1.513 μs	0.0087 μs	0.0081 μs	0.2460	-	4.02 KB
Simple_Moq	175.871 μs	0.5246 μs	0.4380 μs	0.4883	-	14.55 KB
Simple_NSubstitute	5.764 μs	0.0299 μs	0.0280 μs	0.5569	0.0076	9.14 KB
Simple_FakeItEasy	6.535 μs	0.0280 μs	0.0262 μs	0.4959	-	8.11 KB
Simple_TUnitMocks	2.261 μs	0.0553 μs	0.0517 μs	0.4005	0.0076	6.55 KB

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

This is addressed in release v1.5.0.