@magyk/vincent 0.1.5 → 0.1.7

package/CHANGELOG.md

@@ -6,6 +6,32 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
 ---
 
+## [0.1.7] — 2026-05-11
+
+### Fixed
+- Typing long feedback in the scene proposal widget no longer crashes with
+  "Rendered line exceeds terminal width" — the display scrolls to keep the
+  current cursor position visible within the terminal width
+
+---
+
+## [0.1.6] — 2026-05-11
+
+### Fixed
+- `npm install -g` no longer fails when `sharp` cannot build from source — `sharp` and
+  the four main platform prebuilts (`@img/sharp-darwin-arm64`, `@img/sharp-darwin-x64`,
+  `@img/sharp-linux-x64`, `@img/sharp-linux-arm64`) are now `optionalDependencies`;
+  image preview falls back to `jimp` automatically if the native binary is unavailable
+- `loadSystemPrompt` in the bundled binary now correctly accepts a capabilities object
+  instead of treating it as a filename, fixing the `prompt file [object Object] not found`
+  crash on startup
+
+### Changed
+- README expanded with a Getting Started section, configuration paths, and output directory details
+- Build script syncs the npm README from the canonical `README-vincent.md` at build time
+
+---
+
 ## [0.1.5] — 2026-05-11
 
 ### Changed

package/README.md

@@ -1,7 +1,54 @@
 # Vincent
 
 Turn a single product image into a polished marketing video — entirely in your terminal.
-Vincent uses Google Gemini and Veo3 to write the concept, generate scene visuals, animate them, and assemble the final video.
+
+Vincent is an AI agent that takes your product photo and a short brief, then handles everything:
+concept writing, scene image generation, animation, and final video assembly.
+No video editing skills required.
+
+Built on Google Gemini (LLM + image generation) and Veo3 (video generation).
+
+## Getting Started
+
+### 1. Install Node.js 25
+
+Vincent requires Node.js 25 or later. The easiest way is [nvm](https://github.com/nvm-sh/nvm):
+
+```bash
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
+source ~/.nvm/nvm.sh
+nvm install 25
+nvm use 25
+node --version   # should print v25.x.x
+```
+
+### 2. Install Vincent
+
+```bash
+npm install -g @magyk/vincent
+vincent --version
+```
+
+### 3. Get a Google API key
+
+[Google AI Studio](https://aistudio.google.com) is the fastest way to get a key — one key covers the LLM, image generation, and Veo video generation.
+
+1. Go to [aistudio.google.com](https://aistudio.google.com) and sign in with your Google Account.
+2. Click **Get API key** (or **API keys**) in the sidebar.
+3. Click **Create API key**. You can create it in a new or existing Google Cloud project.
+4. Copy the key and keep it somewhere safe — you'll paste it into Vincent on first run.
+
+> **Billing note:** AI Studio uses a tiered billing system (Prepay and Postpay). New accounts start on a free tier with generous rate limits. For high-volume or production use you'll need to link a billing account.
+
+### 4. Make your first video
+
+```bash
+vincent path/to/product-image.jpg
+```
+
+On first run, Vincent will ask you to paste your Gemini API key — it saves it automatically so you only need to do this once. Then describe what you want; it will propose a concept, generate scene images, animate them with Veo3, and assemble the final video in your working directory.
+
+---
 
 ## Install
 
@@ -14,23 +61,41 @@ Requires Node.js ≥ 25.
 ## Quickstart
 
 ```
+export GEMINI_API_KEY=your_key_here
 vincent path/to/product-image.jpg
 ```
 
-On first run, Vincent will prompt you to paste your Gemini API key and save it automatically.
-Get one free at https://aistudio.google.com/apikey — one key covers LLM, image, and video generation.
+Vincent opens an interactive session. Describe what you want; it will propose a concept,
+generate scene images, animate them, and produce a final video in your working directory.
+
+## Configuration
+
+On first run, Vincent creates a settings file at:
+- **Linux:** `~/.local/share/magyk/settings.json`
+- **macOS:** `~/Library/Application Support/magyk/settings.json`
+
+You can also use `/settings` inside the TUI to configure API keys and model preferences,
+or set `GEMINI_API_KEY` in your environment (takes priority over the settings file).
 
 ## Options
 
 ```
-vincent [image] [options]
+vincent [image-url-or-path] [options]
 
-  --video-model <id>   veo3 or veo3-lite (default: veo3-lite)
-  --storage <path>     Override artifact output directory
-  --self-test          Run diagnostics and exit
-  -h, --help           Show help
+  --image <url|path>     Product image (also accepted as a positional arg)
+  --video-model <id>     veo3 or veo3-lite (default: veo3-lite)
+  --storage <path>       Override artifact output directory
+  --self-test            Run built-in diagnostics and exit
+  -h, --help             Show help
 ```
 
+## Output
+
+Each session creates a directory under `~/.local/share/magyk/genartifacts/` (Linux)
+or `~/Library/Application Support/magyk/genartifacts/` (macOS) containing the original
+image, generated scene images, and the final assembled video.
+
 ## License
 
-Proprietary freeware. See LICENSE for terms. © 2026 Magyk Inc.
+See [LICENSE](https://www.npmjs.com/package/@magyk/vincent?activeTab=code) for terms.
+© 2026 Magyk Inc.