Skip to content

docs: fix README search examples to match current CLI and SDK - #54

Closed
priotts wants to merge 1 commit into
ProjectOpenSea:mainfrom
priotts:docs/fix-readme-search-example
Closed

priotts wants to merge 1 commit into
ProjectOpenSea:mainfrom
priotts:docs/fix-readme-search-example

Conversation

@priotts

@priotts priotts commented Oct 3, 2026

Copy link
Copy Markdown

Fixes the README search examples, which use a syntax the current CLI/SDK doesn't accept.

  • Quick Start: opensea search collections "cool cats" -> opensea search "cool cats" --types collection
  • SDK snippet: client.search.collections(...) -> client.search.query(..., { assetTypes: ["collection"] })

Both now match docs/cli-reference.md, docs/examples.md and docs/sdk.md. Verified against the built package: the old snippet throws client.search.collections is not a function, the new one returns results.

Related to #53

@ryanio

ryanio commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator

Thanks for this and for the clear write-up in #53. We've recreated the README fix in our internal monorepo in ProjectOpenSea/opensea-devtools#789 (now merged) with you credited, and it will reach this repo with the next CLI release.

This repo is a read-only mirror, so we can't merge PRs directly, but we review every one.

@ryanio ryanio closed this Oct 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants