Rewrite README with clearer examples and philosophy#100
Open
trycatchal wants to merge 1 commit into
Open
Conversation
Replaces the dated class-based examples (HTBase, WithPreAuth, HasRole, findByIdAndRequire) with the current config-object API (hipExpressHandlerFactory, HTPipe, WithInputSlice, defineExpressHandler, htZodFactory, htMongooseFactory). Opens with a tight value proposition, adds an honest lifecycle table, includes a tRPC example, and trims the walls of FAQ text in favor of focused sections.
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
This is a comprehensive rewrite of the README to better communicate HipThrusTS's core value proposition and make it more accessible to new users. The documentation now leads with concrete, runnable examples and clearer explanations of the framework's philosophy.
Key Changes
WithUserFromReq,RequireThingOwner) and compose them across handlers usingHTPipeNotable Details
HTPipehttps://claude.ai/code/session_01J7B9UtE9SJ5eZ1HKkSRfMM