Skip to content

docs: comprehensive README with integration examples#218

Open
happy-edge wants to merge 1 commit into
jup-ag:mainfrom
happy-edge:docs/improve-readme
Open

docs: comprehensive README with integration examples#218
happy-edge wants to merge 1 commit into
jup-ag:mainfrom
happy-edge:docs/improve-readme

Conversation

@happy-edge

Copy link
Copy Markdown

Summary

Rewrote the README to be more helpful for integrators.

Added

  • Badges: npm version, MIT license
  • Feature highlights: Quick overview of capabilities
  • Quick start guides: Both script tag and npm approaches
  • Display mode examples: Modal, integrated, and widget with code
  • Configuration docs: Form props, wallet passthrough, callbacks, styling
  • Links: Playground, full docs, contributing guide
  • Local dev instructions: How to run locally

Why

The previous README was minimal (just 9 lines). New integrators had to dig through code or external docs to understand how to use the plugin. This README serves as a complete getting-started guide.

Screenshot

The new README provides copy-paste ready code for all common use cases.

- Add badges (npm, license)
- Add feature highlights
- Add quick start guides (script tag + npm)
- Document all display modes with examples
- Document form props, wallet passthrough, callbacks
- Add links to playground and docs
- Add local development instructions
@vercel

vercel Bot commented Feb 6, 2026

Copy link
Copy Markdown

Someone is attempting to deploy a commit to the wowcats Team on Vercel.

A member of the Team first needs to authorize it.

@thejesh23 thejesh23 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big improvement over the 9-line original. Two concrete issues worth fixing before merge:

  1. Hardcoded plugin-1.0.13.js in the script-tag example will bit-rot at the next version bump (and the README is exactly where new integrators will copy from). Worth either pointing at a stable/latest URL, or adding a clear "replace 1.0.13 with the current published version" note with a link to npm/releases. PR #221 in this same repo is wrestling with the same bundle-name problem from the dev side.

  2. initialAmount: '1000000' // in lamports is incorrect when the example pairs it with USDC as the input mint. USDC is 6 decimals; lamports is SOL's unit (9 decimals, 1 SOL = 10⁹ lamports). The right phrasing is "in the input mint's smallest/atomic unit" — otherwise integrators will under/overshoot amounts by 1000×.

Also worth sanity-checking that every prop name in the Form Props block (fixedMint, fixedAmount, swapMode values, etc.) matches the actual FormProps type — README examples that don't typecheck are a common drift point.

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