[BUG]: Missing SDK API documentation and incomplete developer-facing usage guide in StablePay README

[akshadgujarkar]

Bug Description

The current stablepay-sdk README provides a high-level overview of the StablePay widget architecture and clearly documents internal file structure (Widget, PayButton, NetworkDropdown, etc.).
However, it does not provide a proper SDK-level API reference or integration guide for developers using the package.

While the README explains what files exist, it does not explain:
*What the actual public SDK API is
*How developers are expected to import and use StablePay in a project
*What configuration options are available
*What events, callbacks, or props are supported
*Which parts of stablepay-sdk/src are public vs internal implementation
As a result, the README functions more like a codebase overview, not SDK documentation.

Why is this a problem?
This creates confusion for developers and integrators because:
*There is no clear “Getting Started” usage example
*No documented entry point (index exports or SDK initialization flow)
*No explanation of how to use:
->Widget
->PayButton
->network selection flow
->transaction lifecycle callbacks
*Developers must manually inspect the source code to understand usage
*Internal components are documented, but not how to actually consume the SDK
This increases onboarding time and reduces SDK usability.

Steps to Reproduce

Steps to Reproduce

1. In stablepay-sdk/README.md
2. In the “Code Structure Overview” section
3. Look for:
   ->installation instructions
   ->import examples
   ->SDK usage snippets
   ->configuration API
4. Notice that none of the above exist
5. Compare with actual code in stablepay-sdk/src and entry exports
6. Observe missing developer-facing API documentation

Affected Area
->Package: stablepay-sdk
->File: stablepay-sdk/README.md
->Source: stablepay-sdk/src/widget/* and SDK entry exports

Expected Behavior
The README should include a proper SDK documentation section such as:
*Installation guide (npm/yarn/pnpm)
*Basic usage example (minimum working widget integration)
*Public API reference:
->Widget
->PayButton
->NetworkDropdown
->TokenDropdown
->transaction callbacks/events
*Configuration options (props, network config, payment settings)
*Example integration flow (merchant checkout use case)
*Clear distinction between:
*public SDK exports
*internal implementation files

Actual Behavior
The README currently:
*Focuses on repository structure instead of SDK usage
*Lists internal widget file breakdown
*Does not explain how to actually integrate or use StablePay in a project
*Lacks API reference or developer onboarding guide

Logs and Screenshots

No logs apply.

Environment Details

->Area: stablepay-sdk
->File: README.md
->Repro: As of Mar 27, 2026
->Impact: SDK users and maintainers

Impact

Medium - Feature works but has issues

Code of Conduct

• I have joined the Discord server and will post updates there
• I have searched existing issues to avoid duplicates

[akshadgujarkar]

Could you pls assign this issue to me? I am very much interested in working on it.