feedeas 0.1.0-alpha.2 → 0.1.0-alpha.3

package/.env.example

@@ -0,0 +1,15 @@
+# Feedeas Environment Variables
+
+# Gemini API Key (for 'imagine' command)
+# Get your API key at: https://aistudio.google.com/app/apikey
+GEMINI_API_KEY=your-gemini-api-key-here
+
+# Setup Instructions:
+# 1. Copy this file to .env
+# 2. Replace the placeholder value with your actual Gemini API key
+# 3. The CLI will automatically load this value
+#
+# Example:
+#   cp .env.example .env
+#   # Edit .env with your API key
+#   feedeas imagine "a beautiful sunset"

package/README.md

@@ -1,15 +1,141 @@
-# feedeas
+# Feedeas
 
-To install dependencies:
+**Feedeas** is an agentic video creation tool that allows you to programmatically create videos using JSON scene definitions. Perfect for automated content generation, social media posts, and AI-driven video workflows.
+
+## Features
+
+- 🎬 **Programmatic Video Creation** - Define scenes using simple JSON
+- 🎨 **AI Image Generation** - Built-in support for Google Imagen AI
+- 🖼️ **Rich Media Support** - Text, images, and audio with transitions
+- 🤖 **Agent-Friendly** - Designed for AI agents and automation
+- 🎯 **Interactive Editor** - Web-based UI for visual editing
+- ⚡ **Fast Rendering** - Powered by Playwright and FFmpeg
+
+## Quick Start
+
+### Installation
 
 ```bash
 bun install
+bun run build
+```
+
+### Basic Usage
+
+```bash
+# Create a scene template
+feedeas example basic > scene.json
+
+# Validate the scene
+feedeas validate scene.json
+
+# Open interactive editor
+feedeas edit
+
+# Render to video
+feedeas record --project scene.json
+```
+
+## Commands
+
+### Video Creation
+
+- `feedeas edit [dir]` - Start the interactive editor
+- `feedeas record` - Render scene to video
+- `feedeas snap <time>` - Take a snapshot at specific time
+- `feedeas validate <file>` - Validate scene JSON
+
+### AI Image Generation
+
+Generate images using Google's Imagen AI (via Gemini API):
+
+```bash
+# Setup (one-time): Get API key from https://aistudio.google.com/app/apikey
+export GEMINI_API_KEY="your-api-key"
+
+# Basic usage - saves to assets/mountain.png
+feedeas imagine "A serene mountain landscape"
+
+# Multiple images - saves to assets/pattern_1.png, pattern_2.png, etc.
+feedeas imagine "Abstract art" -n 4 -o pattern.png
+```
+
+**Images save to `./assets/` by default** - perfect for video workflows!
+
+**[📖 Full Imagine Command Documentation](./docs/IMAGINE_COMMAND.md)**
+
+### Scene Management
+
+- `feedeas example [type]` - Generate example scenes
+- `feedeas set-scene <file>` - Create/update scene programmatically
+- `feedeas inspect` - Inspect project assets
+- `feedeas schema` - Show entity schema information
+
+## Project Structure
+
+```
+your-project/
+├── scene_1.json          # Scene definition
+├── assets/               # Images, audio files
+│   ├── background.png
+│   ├── music.mp3
+│   └── ...
+└── output.mp4           # Generated video
+```
+
+## Scene File Format
+
+```json
+{
+  "meta": {
+    "width": 1080,
+    "height": 1350,
+    "duration": 5
+  },
+  "entities": [
+    {
+      "id": "text-1",
+      "type": "text",
+      "text": "Hello, World!",
+      "startTime": 0,
+      "duration": 5,
+      "x": 100,
+      "y": 500,
+      "fontSize": 80,
+      "color": "#ffffff",
+      "enter": { "type": "fade", "duration": 0.5 }
+    }
+  ]
+}
 ```
 
-To run:
+## Documentation
+
+- [Imagine Command Guide](./docs/IMAGINE_COMMAND.md) - AI image generation
+- Run `feedeas --help` for full CLI documentation
+- Run `feedeas <command> --help` for command-specific help
+
+## Development
 
 ```bash
-bun run index.ts
+# Run in development mode
+bun run dev
+
+# Build CLI and UI
+bun run build
+
+# Run CLI directly
+bun run feedeas
 ```
 
-This project was created using `bun init` in bun v1.2.2. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+## Requirements
+
+- [Bun](https://bun.sh) v1.2.2 or later
+- Node.js 20.19+ or 22.12+ (for Vite)
+- FFmpeg (for video rendering)
+- Gemini API key (for AI image generation) - Get free at https://aistudio.google.com/app/apikey
+
+## License
+
+This project was created using `bun init` in bun v1.2.2.
+