create-hybrid 1.2.5 → 1.2.7

package/README.md

@@ -1,98 +1,66 @@
-# create-hybrid
+# Hybrid - Typescript Framework for building commerce-connected AI Agents.
 
-Create a new Hybrid XMTP agent project with a single command.
+An open-source agent framework for building conversational AI agents on XMTP. 
 
-## Usage
+Hybrid makes it easy for developers to create intelligent agents that can understand natural language, process messages, and respond through XMTP's decentralized messaging protocol.
 
-```bash
-# Create a new project
-npx create hybrid my-agent
+See [http://hybriddev.com](http://hybrid.dev) for more information.
+
+## 📦 Quickstart
+
+Getting started with Hybrid is simple:
 
-# Create in current directory
-npx create hybrid .
+### 1. Initialize your project
 
-# Interactive mode (will prompt for name)
-npx create hybrid
+```bash
+npm create hybrid my-agent
+cd my-agent
 ```
 
-## What it creates
+This creates all the necessary files and configuration for your agent.
 
-This package creates a new Hybrid XMTP agent project with:
+### 2. Get your OpenRouter API key
+   
+Visit [OpenRouter](https://openrouter.ai/keys), create an account and generate an API key
 
-- **TypeScript configuration** - Ready-to-use TypeScript setup
-- **Agent template** - Pre-configured agent with OpenRouter integration
-- **Development scripts** - Build, dev, test, and lint commands
-- **Environment setup** - Template `.env` file with required variables:
+Add it to your `.env` file:
 
 ```env
-# OpenRouter Configuration
-# Get your OpenRouter API key from https://openrouter.ai/keys
 OPENROUTER_API_KEY=your_openrouter_api_key_here
-
-# XMTP Wallet and Encryption Keys
-# Run 'npx hybrid keys' to generate these values
-XMTP_WALLET_KEY=your_wallet_key_here
-XMTP_ENCRYPTION_KEY=your_encryption_key_here
-
-# XMTP Environment (dev, production)
-XMTP_ENV=production
-
-# Server Configuration
-# PORT=8454
 ```
-- **Testing framework** - Vitest configuration for unit tests
 
-## Project structure
+### 3. Generate XMTP keys
 
-```
-my-agent/
-├── src/
-│   ├── agent.ts          # Main agent implementation
-│   └── agent.test.ts     # Example tests
-├── .env                  # Environment variables
-├── .gitignore           # Git ignore rules
-├── package.json         # Dependencies and scripts
-├── tsconfig.json        # TypeScript configuration
-├── vitest.config.ts     # Test configuration
-└── README.md           # Project documentation
+```bash
+hybrid keys
 ```
 
-## Next steps
+or automatically add it to your `.env` file:  
 
-After creating your project:
-
-1. **Install dependencies**
-   ```bash
-   cd my-agent
-   npm install
-   ```
+```bash
+hybrid keys --write
+```
 
-2. **Get your OpenRouter API key**
-   - Visit [OpenRouter](https://openrouter.ai/keys)
-   - Create an account and generate an API key
-   - Add it to your `.env` file
+### 4. Register your wallet with XMTP
 
-3. **Generate XMTP keys**
-   ```bash
-   npm run keys
-   ```
+```bash
+hybrid register
+```
 
-4. **Start development**
-   ```bash
-   npm run dev
-   ```
+This generates secure wallet and encryption keys for your XMTP agent.
 
-## Requirements
+### 5. Register your wallet with XMTP
 
-- Node.js 20 or higher
-- npm, yarn, or pnpm
+```bash
+hybrid register
+```
 
-## Related packages
+  ### 6. Start developing
 
-- [`hybrid`](../core) - The main Hybrid framework
-- [`@hybrd/cli`](../cli) - CLI tools for Hybrid development
-- [`@hybrd/xmtp`](../xmtp) - XMTP client integration
+```bash
+hybrid dev
+```
 
-## License
+Your agent will start listening for XMTP messages and you're ready to build! 
 
-MIT
+Go to [https://xmtp.chat/dm/](https://xmtp.chat/dm/) and send a message to your agent.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-hybrid",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "description": "Create a new Hybrid XMTP agent project",
   "type": "module",
   "bin": {
@@ -24,8 +24,8 @@
     "@types/node": "22.8.6",
     "@types/prompts": "^2.4.9",
     "tsup": "^8.5.0",
-    "@config/tsconfig": "0.0.0",
-    "@config/biome": "0.0.0"
+    "@config/biome": "0.0.0",
+    "@config/tsconfig": "0.0.0"
   },
   "engines": {
     "node": ">=20"