readme: rewrite with full v2 usage docs - #31
Draft
prodiapcode wants to merge 2 commits into
Draft
prodiapcode wants to merge 2 commits into
prodiapcode wants to merge 2 commits into
Conversation
prodiapcode
force-pushed
the
docs/improve-readme
branch
from
August 31, 2026 15:24
e97739b to
f5c0bfc
Compare
Cover client configuration, output reading, output formats, image inputs, video generation, and typed error handling. Drop the stale October 2024 subscription note. Co-Authored-By: Monty Anderson <work@montyanderson.net>
Logo mark + wordmark taken from the current brand assets in prodia-mvp/v2-docs, with a prefers-color-scheme style so it renders black on light and white on dark GitHub themes. Co-Authored-By: Monty Anderson <work@montyanderson.net>
prodiapcode
force-pushed
the
docs/improve-readme
branch
from
August 31, 2026 15:28
f5c0bfc to
d1d6ba6
Compare
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.
What
Rewrites the readme to actually document what the SDK can do. The old readme had a single txt2img example and stopped there.
New sections:
baseUrl,maxErrors,maxRetrieswith defaultsarrayBuffer()/uint8Array()/formData()acceptoptioninputsoption (img2img example, mirrors the docs.prodia.com guide)ProdiaUserError/ProdiaCapacityError/ProdiaBadResponseErrorand the built-in retry behaviorAlso drops the stale "as of October 2024, v2 requires Pro+" note and keeps the v1 legacy section (marked deprecated).
Notes
v2/index.tsAPI surface and use job types from the existing tests and docs.prodia.com guides (inference.flux.dev.txt2img.v1,inference.flux-2.klein.img2img.v1,inference.veo.fast.txt2vid.v1).deno fmt --check readme.mdpasses.🤖 Generated with Claude Code