@payai/x402-fetch-starter 0.1.0 → 0.1.1

package/README.md

@@ -1,38 +1,56 @@
-## x402 Fetch Starter
+# x402 Fetch Starter
 
-Starter and sync wrapper around the upstream example at [coinbase/x402 → examples/typescript/clients/fetch](https://github.com/coinbase/x402/tree/main/examples/typescript/clients/fetch). This repo provides:
+Starter for running an x402 fetch client.
 
-- **Scaffold CLI**: quickly create a runnable x402 client template using `x402-fetch`.
-- **Auto-sync**: keeps the template’s example code aligned with the upstream example via GitHub Actions and opens a PR with changes.
+You can find the upstream example at [coinbase/x402 → examples/typescript/clients/fetch](https://github.com/coinbase/x402/tree/main/examples/typescript/clients/fetch). 
+
+## Getting Started
 
 ### Requirements
 
 - **Node.js**: 18 or newer
-- **GitHub Actions** enabled in your fork/repo
 
-### Create a new app from the template
+### Create a new app using the template
 
-Use any of the following:
+Use your preferred package manager to scaffold:
 
+#### npm (npx)
 ```bash
-# npm
 npm exec @payai/x402-fetch-starter -- my-x402-app
+```
 
-# pnpm
+#### pnpm
+```bash
 pnpm dlx @payai/x402-fetch-starter my-x402-app
+```
 
-# bun
+#### bun
+```bash
 bunx @payai/x402-fetch-starter my-x402-app
 ```
 
 Then inside your new app:
 
 ```bash
-cp .env-local .env
-npm i
 npm run dev
 ```
 
+### How the created client example works
+
+When you run the generated app, `index.ts` will:
+
+- Load environment variables from `.env` (for example: `RESOURCE_SERVER_URL`, `ENDPOINT_PATH`, `PRIVATE_KEY`).
+- Create a wallet client and wrap the native `fetch` with x402 using `wrapFetchWithPayment`.
+- Call your configured endpoint at `${RESOURCE_SERVER_URL}${ENDPOINT_PATH}`.
+- Log two things to the console:
+  - The parsed JSON response body
+  - The decoded `x-payment-response` headers (useful for inspecting payment receipts/metadata)
+
+
+## The Starter Itself
+
+Below are notes on the starter itself, which creates the example that devs use to get started.
+
 ### How sync works
 
 - Workflow: `.github/workflows/sync.yml`

package/bin/create.js

@@ -29,6 +29,35 @@ if (fs.existsSync(rootPkgPath)) {
   fs.writeFileSync(rootPkgPath, JSON.stringify(rootPkg, null, 2));
 }
 
+// perform post-scaffold steps for convenience
+console.log(`\nSetting up your project in: ${targetDir}`);
+
+// 1) Copy environment template
+try {
+  const envLocal = path.join(targetDir, ".env-local");
+  const envExample = path.join(targetDir, ".env.example");
+  const envTarget = path.join(targetDir, ".env");
+  if (fs.existsSync(envLocal)) {
+    console.log("- Creating .env from .env-local");
+    fs.copyFileSync(envLocal, envTarget);
+  } else if (fs.existsSync(envExample)) {
+    console.log("- Creating .env from .env.example");
+    fs.copyFileSync(envExample, envTarget);
+  } else {
+    console.log("- No .env-local or .env.example found; please create .env manually");
+  }
+} catch (err) {
+  console.warn("- Skipped env setup:", err instanceof Error ? err.message : String(err));
+}
+
+// 2) Install dependencies
+try {
+  console.log("- Installing dependencies (npm install)...");
+  execSync("npm install", { stdio: "inherit", cwd: targetDir });
+} catch (err) {
+  console.warn("- npm install failed, you may run it manually:", err instanceof Error ? err.message : String(err));
+}
+
 // init git
 try {
   execSync("git init", { stdio: "ignore", cwd: targetDir });
@@ -36,13 +65,17 @@ try {
 
 // print next steps
 console.log(`
-Scaffolded ${projectName}!
+Successfully created ${projectName}!
+
+You now have a starter example for Fetch wrapped with x402 payment handling.
 
 Next steps:
   cd ${projectName}
-  cp .env-local .env  # then edit the values inside .env
-  npm i
+  # edit values inside .env
   npm run dev
 
+After install, open the main file (e.g., index.ts) to see how the example works.
+Docs: https://docs.payai.network
+
 Happy building 🏗️
 `);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@payai/x402-fetch-starter",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": false,
   "description": "Create an x402 Fetch client without cloning the monorepo.",
   "type": "module",
@@ -35,4 +35,4 @@
   "config": {
     "x402FetchVersion": "0.5.1"
   }
-}
+}