docs: add npm usage with a type-safe OpenAI example#69
Merged
Conversation
Lead the README with `npm install modelparams` and a short OpenAI SDK snippet showing `ParamsOf<Id>` catch an unsupported param at compile time. Trim the intro, API, and contributing sections so the page stays short and points to the package README for the rest.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
💭 Why
The README never mentioned the
modelparamsnpm package or showed how the types stop you from passing a parameter a model doesn't accept.✨ What changed
npm installplus an OpenAI SDK snippet built onParamsOf<Id>.top_kongpt-4.1as a compile error, verified against the generated types.👤 For users
A reader landing on the repo sees the type-safe path first, with a copy-pasteable OpenAI example.