Repository navigation
docs: add package deprecation warning - #42
Merged
Merged
Conversation
naruto11eth
approved these changes
Oct 8, 2026
naruto11eth
left a comment
naruto11eth
left a comment
There was a problem hiding this comment.
README-only, link resolves to the migration guide and this package is one of the ones it covers. Approving.
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
2 participants
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.
Adds a deprecation warning at the top of the README, directing users to the unified Polymarket SDK and its migration guide.
Validation: checked the warning text and migration link, confirmed only
README.mdchanged, and rangit diff --check. Documentation-only change.Note
Low Risk
Documentation-only README change with no code or release behavior impact.
Overview
Adds a prominent GitHub WARNING callout at the top of
README.mdstating that@polymarket/builder-relayer-clientis deprecated and pointing readers to the unified Polymarket SDK via the official migration guide.No runtime, API, or dependency changes—only README documentation so new visitors see the migration path before install/quick-start content.
Reviewed by Cursor Bugbot for commit e6565bf. Bugbot is set up for automated code reviews on this repo. Configure here.