docs: add initial README with usage and setup instructions#26
Open
stefan-b10 wants to merge 1 commit intoPolymarket:masterfrom
Open
docs: add initial README with usage and setup instructions#26stefan-b10 wants to merge 1 commit intoPolymarket:masterfrom
stefan-b10 wants to merge 1 commit intoPolymarket:masterfrom
Conversation
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
Adds a README file to improve developer onboarding and clarify repository purpose.
Changes
Why
This repo currently lacks documentation, making it harder for contributors to understand and use.
Notes
Happy to adjust structure or level of detail based on feedback.
Note
Low Risk
Documentation-only change adding a new README; no runtime/code-path impact aside from potential for outdated/misleading usage guidance.
Overview
Adds a new
README.mdthat documents the Polymarket TypeScript SDK’s purpose (building deterministic proxy-walletTransactionpayloads), Node.js requirement, andCallTypesemantics.Includes usage examples for common workflows (proxy wallet address derivation, market buys, conditional token split/merge/redeem, debt actions, negRisk operations, UMA adapter initialization) plus a short utilities/helpers reference and license.
Written by Cursor Bugbot for commit b02f65d. This will update automatically on new commits. Configure here.