Rewrite the README as a complete guide to the library - #173
Merged
Conversation
- Replace the dead CircleCI badge with the GitHub Actions one and the godoc badge with pkg.go.dev. - Organise the content by task: building requests, asserting on responses, mocking, sequence diagrams, networking, debugging, framework integration. - Document features that were missing: HttpRequest, GraphQL, JSON request bodies, HeaderPresent/NotPresent, custom assertions and the IsSuccess helpers, Result.JSON, mock request/response builders, Times/AnyTimes/UnmatchedMocks, FixedDelay/Timeout, ObserveMocks, standalone mocks, HttpClient and the parallel-test caveat, Meta participant names, x/db database recording, custom reporters, EnableNetworking, TestingT/Ginkgo and Verifier. - Fix examples that did not compile: apitest.Cookie is not a function (NewCookie), 'var x :=', and a malformed query collection snippet. - Add the websocket and database examples to the examples table. Every Go snippet in the README was extracted and compiled against the library. Co-Authored-By: Claude Fable 5.1 <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
1 participant
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
A rewrite of the README as a complete guide to the library, organised by task rather than as a list of snippets.
HttpRequest, GraphQL, JSON request bodies,HeaderPresent/HeaderNotPresent, custom assertions and theIsSuccesshelpers,Result.JSON, the mock request and response builders,Times/AnyTimes/UnmatchedMocks,FixedDelay/Timeout,ObserveMocks, standalone mocks,HttpClientand the caveat about parallel tests,Metaparticipant names,x/dbdatabase recording, custom reporters,EnableNetworking,TestingT/Ginkgo andVerifier.apitest.Cookie(...)is not a function (it'sNewCookie),var x := ..., and a malformed query-collection snippet.Every Go snippet in the README was extracted and compiled against the library to check it.
🤖 Generated with Claude Code