@openagentmarket/create-agent 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,33 @@
+# @openagentmarket/create-agent
+
+The quickest way to start building an OpenAgent. This CLI tool scaffolds a comprehensive TypeScript project with all necessary configurations and dependencies.
+
+## Usage
+
+Run the following command to create a new agent:
+
+```bash
+npm create @openagentmarket/agent@latest
+# or
+npx @openagentmarket/create-agent@latest
+```
+
+Follow the interactive prompts to name your agent.
+
+## What is included?
+
+The scaffolded project includes:
+- **TypeScript** configuration for modern Node.js development.
+- **ESLint & Prettier** setup (implied standards).
+- **@openagentmarket/nodejs** SDK integration.
+- **Example Agent** code (`index.ts`) demonstrating the basic structure.
+- **Environment Configuration** (`.env`) template.
+
+## Getting Started with your new Agent
+
+Once created:
+
+1.  Navigate to your project directory: `cd <your-agent-name>`
+2.  Install dependencies: `pnpm install` (or `npm install`)
+3.  Configure your `.env` file with a valid mnemonic.
+4.  Start dev mode: `pnpm dev`

package/dist/index.js

@@ -101,6 +101,50 @@ async function main() {
 main().catch(console.error);
 `;
     fs.writeFileSync(path.join(targetDir, 'index.ts'), indexTs);
+    // 5. README.md
+    const readme = `# ${projectName}
+
+## Getting Started
+
+This project was scaffolded with \`@openagentmarket/create-agent\`.
+
+### Prerequisites
+
+- Node.js (v18 or higher)
+- pnpm (recommended) or npm
+
+### Installation
+
+\`\`\`bash
+pnpm install
+\`\`\`
+
+### Configuration
+
+1.  Copy the example environment file:
+    \`\`\`bash
+    cp .env.example .env
+    \`\`\`
+2.  Edit \`.env\` and add your 12-word mnemonic phrase.
+
+### Running the Agent
+
+\`\`\`bash
+# Development mode with hot-reload
+pnpm dev
+
+# Production build
+pnpm build
+pnpm start
+\`\`\`
+
+## Agent Details
+
+- **Name**: ${projectName}
+- **Framework**: @openagentmarket/nodejs
+- **Network**: Base (Coinbase L2)
+`;
+    fs.writeFileSync(path.join(targetDir, 'README.md'), readme);
     console.log(kleur.green('Success! Project created.'));
     console.log('\nNext steps:');
     console.log(`  cd ${projectName}`);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openagentmarket/create-agent",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "CLI to scaffold a new OpenAgent project",
     "type": "module",
     "bin": {

package/src/index.ts

@@ -113,6 +113,51 @@ main().catch(console.error);
 `;
     fs.writeFileSync(path.join(targetDir, 'index.ts'), indexTs);
 
+    // 5. README.md
+    const readme = `# ${projectName}
+
+## Getting Started
+
+This project was scaffolded with \`@openagentmarket/create-agent\`.
+
+### Prerequisites
+
+- Node.js (v18 or higher)
+- pnpm (recommended) or npm
+
+### Installation
+
+\`\`\`bash
+pnpm install
+\`\`\`
+
+### Configuration
+
+1.  Copy the example environment file:
+    \`\`\`bash
+    cp .env.example .env
+    \`\`\`
+2.  Edit \`.env\` and add your 12-word mnemonic phrase.
+
+### Running the Agent
+
+\`\`\`bash
+# Development mode with hot-reload
+pnpm dev
+
+# Production build
+pnpm build
+pnpm start
+\`\`\`
+
+## Agent Details
+
+- **Name**: ${projectName}
+- **Framework**: @openagentmarket/nodejs
+- **Network**: Base (Coinbase L2)
+`;
+    fs.writeFileSync(path.join(targetDir, 'README.md'), readme);
+
     console.log(kleur.green('Success! Project created.'));
     console.log('\nNext steps:');
     console.log(`  cd ${projectName}`);