Skip to content

Add Quick start usage examples to README - #67

Merged
marius-bughiu merged 1 commit into
mainfrom
docs/readme-usage-examples
May 2, 2026
Merged

Add Quick start usage examples to README#67
marius-bughiu merged 1 commit into
mainfrom
docs/readme-usage-examples

Conversation

@marius-bughiu

Copy link
Copy Markdown
Owner

Summary

  • Adds a Quick start section to README.md with concrete, runnable usage examples for the common shapes: IntDictionary, CelerityDictionary (with GuidHasher, StringFnV1AHasher, and DefaultHasher<T>), the sets (IntSet, CeleritySet), and the IEnumerable<KeyValuePair<,>> constructor.
  • Each snippet exercises the actual public API (indexer get/set, TryAdd / Add semantics, TryGetValue, Remove, bulk-load from a BCL Dictionary<,>).
  • Closes the "Add usage examples to README" sub-task from the documentation backlog. The remaining sub-items on Improve documentation #15 (performance tuning guide, "when to use which collection", migration guide, troubleshooting / FAQ) remain open and will land in follow-up PRs.

Refs #15.

Test plan

  • dotnet build — green (existing build, no source changes).
  • dotnet test on CI — docs-only change; verifies nothing in the repo regressed.
  • Visual review of the README — Quick start sits between Collections and Benchmarks; existing "Custom hashing" section is unchanged and cross-linked from Quick start.
  • CHANGELOG [Unreleased] updated with the corresponding Added entry.

🤖 Generated with Claude Code

Adds a concrete, runnable Quick start section to the README covering
IntDictionary, CelerityDictionary (with GuidHasher, StringFnV1AHasher,
DefaultHasher<T>), the sets, and the IEnumerable<KeyValuePair<,>>
constructor. Closes the "Add usage examples to README" item from the
documentation backlog (#15).
@marius-bughiu
marius-bughiu merged commit 2d863bb into main May 2, 2026
3 checks passed
@marius-bughiu
marius-bughiu deleted the docs/readme-usage-examples branch July 24, 2026 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant