@ignix-social/creator 0.0.0-stage → 0.1.1

package/README.md

@@ -1,3 +1,58 @@
-# Temporary Holding Version
+# Ignix Creator
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Generation tools for your AI agent (Claude, Codex…), on your own computer or on Ignix Cloud Boost: talking presenters from a photo, photo → video, text → video, putting a person in a video, dubbing, and the edits and clips of your own videos. Your agent drives it over MCP; you approve anything that spends credits, changes your Ignix account, downloads software or uses a real person's photo.
+
+Ignix Creator is for Ignix customers: it needs an active [Ignix plan](https://ignix.social/pricing), and you sign in with your Ignix account.
+
+## Install
+
+Your agent normally does this for you, following Ignix's playbook. By hand, in your own folder (no `sudo`, no global install):
+
+```sh
+npm install --prefix ~/.ignix-creator/cli @ignix-social/creator
+~/.ignix-creator/cli/node_modules/.bin/ignix-creator login
+```
+
+Windows PowerShell:
+
+```powershell
+npm.cmd install --prefix "$env:USERPROFILE\.ignix-creator\cli" @ignix-social/creator
+& "$env:USERPROFILE\.ignix-creator\cli\node_modules\.bin\ignix-creator.cmd" login
+```
+
+`login` opens your browser on Ignix; sign in and allow Ignix Creator. Then add it to your agent as an MCP server whose command is `ignix-creator mcp`, for example in Claude Code:
+
+```sh
+claude mcp add --scope user ignix-creator -- ~/.ignix-creator/cli/node_modules/.bin/ignix-creator mcp
+```
+
+## Commands
+
+```
+ignix-creator login            sign in to Ignix in your browser
+ignix-creator logout
+ignix-creator status           account, plan and what waits for your approval
+ignix-creator doctor           what this computer can run
+ignix-creator engines          local engines and their state
+ignix-creator engines install <item...> [--accept-licence minimax_h3]
+ignix-creator engines cancel   stop the install in progress
+ignix-creator approve          show again the approvals that wait
+ignix-creator mcp              the MCP server for your agent (stdio)
+ignix-creator service start|stop|status
+```
+
+## How it works
+
+- A small background service keeps running your jobs (renders, Cloud Boost runs, local engines) after your agent's session ends. `ignix-creator mcp` starts it when it is not running; `ignix-creator service stop` stops it.
+- **Approvals are yours.** When your agent asks for something that needs you, Ignix Creator shows a window of your system (in your computer's language) saying which agent asks, what it will do, its credits and why it needs you. Decline is the default. Your agent cannot answer it for you.
+- Your Ignix sign-in is encrypted with a key kept by your system (the macOS Keychain, or Windows DPAPI for your user). Nothing is stored in plain text.
+- Everything lives in `~/.ignix-creator` (`%USERPROFILE%\.ignix-creator` on Windows): your projects, results, downloaded engines and logs. Deleting your Ignix account does not remove it; you can delete it yourself at any time.
+- Local engines are optional and downloaded only when you approve them. Cloud Boost runs in Ignix's cloud and spends AI credits from your plan, with the price shown before you approve.
+- It uses [Ignix Editor](https://www.npmjs.com/package/@ignix-social/editor) (Apache-2.0), installed with it at the exact version it is tested with.
+- No automatic updates: the version you install is the version that runs.
+
+Requires Node.js 22.12 or newer. Runs on macOS (Intel and Apple Silicon) and Windows 10/11 (x64). Machines with 8 GB of memory can render video; local image generation needs 12 GB.
+
+## License
+
+Proprietary software of Dreaming Solutions LLC (Ignix). Use requires an active Ignix plan and is subject to the [Ignix Terms](https://ignix.social/legal/terms).