Add README with usage examples and API docs links#70
Merged
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a top-level README to document the Wolfgang.TryPattern library, aimed at helping consumers install the NuGet package and understand core APIs and common usage patterns.
Changes:
- Introduces installation instructions (CLI + Package Manager).
- Adds usage examples (sync, async, cancellation) and guidance for combining
Results. - Links to hosted API documentation/reference and provides target framework + build-from-source sections.
- Database access with Try.Run (sync and async) - Result as a repository return type (CRUD without Try.Run) - Web API controller mapping Result to HTTP responses - Chaining validation with Result.Flatten before execution Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Remove broken docs/README-FORMATTING.md link (file doesn't exist) - Clarify RunAsync runs sync action on thread pool, not async - Update cancellation example to show cooperative token checking Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
🤖 Generated with Claude Code