@masterpeach/plugin-react 0.0.0-experimental-20260625203238

package/README.md

@@ -0,0 +1,156 @@
+# @peach/plugin-react
+
+Public React package for embedding Peach Plugin in npm/bundler applications.
+
+## Install
+
+```bash
+pnpm add @peach/plugin-react react react-dom wagmi viem @wagmi/core @tanstack/react-query @reown/appkit @reown/appkit-adapter-wagmi
+```
+
+React, wagmi, viem, TanStack Query, and AppKit packages are peer dependencies and stay external in the ESM build.
+
+## Usage
+
+```tsx
+import { PeachPlugin, type PeachPluginReactOptions } from "@peach/plugin-react";
+
+const options: PeachPluginReactOptions = {
+  display: {
+    mode: "integrated",
+  },
+  theme: "light",
+  defaultTokens: {
+    sell: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE",
+    buy: "0x55d398326f99059fF775485246999027B3197955",
+  },
+};
+
+export function SwapPanel() {
+  return <PeachPlugin {...options} />;
+}
+```
+
+## Styles
+
+The default `useShadowDOM={true}` mode injects plugin styles into the shadow root. If you render into the host document with `useShadowDOM={false}`, import the optional stylesheet:
+
+```tsx
+import "@peach/plugin-react/style.css";
+```
+
+## Build Output
+
+- ESM entry: `dist/index.js`
+- Types: `dist/index.d.ts`
+- Optional stylesheet: `dist/plugin-react.css`
+
+## NPM Publish Script
+
+Publish through the existing monorepo script only. Do not run `npm publish`
+manually for this package; the script writes the version, builds, runs the
+release guard, packs the package, and publishes the verified tarball.
+
+Run every publish command from the monorepo root. The default script target is
+`@peach/plugin-react`; pass `--package <name-or-dir>` only when publishing another
+non-private package under `packages/plugin/*`.
+
+Replace `<version>` with the version you want to publish. Use a prerelease
+version such as `<prerelease-version>` for test releases.
+
+### 1. Prepare npm access
+
+Make sure the shell is authenticated before publishing:
+
+```bash
+npm whoami
+```
+
+If publishing from CI, provide `NODE_AUTH_TOKEN` through the CI environment. If
+npm two-factor auth is enabled and the token does not bypass 2FA, pass
+`--otp <code>` when publishing.
+
+### 2. Dry-run with the script
+
+Dry-run with the exact version you plan to publish:
+
+```bash
+pnpm plugin:publish -- --version <version> --dry-run
+```
+
+The publish script writes the requested version into the package manifest before
+building, so keep the `package.json` version change as part of the release
+commit.
+
+### 3. Publish a test release with the script
+
+Use the test release script for prerelease validation. It publishes with the
+`test` npm dist-tag:
+
+```bash
+pnpm plugin:publish:test -- --version <prerelease-version>
+```
+
+Equivalent environment-driven command:
+
+```bash
+PEACH_PLUGIN_RELEASE_ENV=test PEACH_PLUGIN_VERSION=<prerelease-version> pnpm plugin:publish
+```
+
+After publishing, verify the published package and wire it into the debug app if
+needed:
+
+```bash
+npm view @peach/plugin-react@test version
+pnpm --filter plugin-debug dev
+```
+
+### 4. Publish production with the script
+
+Use the production release script for the final version. It publishes with the
+`latest` npm dist-tag:
+
+```bash
+pnpm plugin:publish:prod -- --version <version>
+```
+
+Equivalent environment-driven command:
+
+```bash
+PEACH_PLUGIN_RELEASE_ENV=production PEACH_PLUGIN_VERSION=<version> pnpm plugin:publish
+```
+
+### 5. Optional flags and environment defaults
+
+CLI flags:
+
+```bash
+pnpm plugin:publish -- \
+  --package @peach/plugin-react \
+  --version <version> \
+  --tag latest \
+  --registry https://registry.npmjs.org/ \
+  --otp <code>
+```
+
+Environment defaults:
+
+- `PEACH_PLUGIN_RELEASE_ENV`: `test`, `production`, or `prod`.
+- `PEACH_PLUGIN_PACKAGE`: same as `--package`.
+- `PEACH_PLUGIN_VERSION`: same as `--version`.
+- `PEACH_PLUGIN_TAG`: same as `--tag`; overrides the release-env tag default.
+- `PEACH_PLUGIN_REGISTRY`: same as `--registry`.
+- `PEACH_PLUGIN_OTP`: same as `--otp`.
+- `PEACH_PLUGIN_DRY_RUN`: set to `1`, `true`, `yes`, or `on` to enable dry-run.
+
+CLI flags override environment defaults.
+
+### Script behavior
+
+`packages/plugin/scripts/publish-package.mjs` resolves a non-private package from
+`packages/plugin/*`, writes the target version to its `package.json`, runs
+`pnpm --filter <pkg> build`, runs `pnpm --filter <pkg> test:release`, creates a
+temporary tarball with `pnpm pack`, and publishes that verified tarball with
+`npm publish`.
+
+For script-tag CDN usage, use `@peach/plugin-script` instead.