mediaxg 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mediaXG contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,64 @@
-# Temporary Holding Version
+# mediaXG
 
-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.
+Premium terminal-based AI coding agent with multi-provider support, streaming, reasoning controls, Plan/Build modes, native coding tools, Skills, MCP, session persistence, and transparent cost controls.
+
+## Features
+
+- **Multi-provider support**: OpenAI-compatible, Anthropic-compatible, xKiro
+- **Real streaming**: Genuine incremental streaming with reasoning controls
+- **Plan/Build/Review modes**: Mode-based workflow with appropriate permissions
+- **Native coding tools**: File operations, search, diff, process execution
+- **Attachments**: Queue workspace text files and PNG/JPEG/WebP images in the TUI with `/attach`, or send one with `/attach <path> [question...]`
+- **Skills system**: Agent Skills convention with discovery and activation
+- **MCP support**: Streamable HTTP and stdio transports
+- **Session persistence**: Versioned JSON store with search, resume, export
+- **Context management**: Requested budgets up to 5M tokens — always clamped by real model/provider limits, with assembly provenance, retrieval, and compaction
+- **Budget controls**: Usage tracking, pricing, spending limits
+- **Security**: Environment/file credential storage, permission engine, path traversal prevention
+- **Session automation**: `/auto true` skips consequential-action prompts for the current app session; deny rules, read-only modes, and workspace guards still apply
+
+## Installation
+
+Requires Bun 1.1 or newer. Install the CLI from npm:
+
+```bash
+npm install --global mediaxg
+mediaxg
+```
+
+To develop from source, clone the repository and run `bun install`.
+
+## Development
+
+```bash
+bun run dev
+```
+
+## Build
+
+```bash
+bun run build
+```
+
+## Testing
+
+```bash
+bun test
+```
+
+## Configuration
+
+Configuration is stored in:
+
+- Project: `.mediaxg/config.json`
+- User: `~/.config/mediaxg/config.json`
+
+Credentials resolve from environment variables first, then the local file
+`~/.config/mediaxg/credentials.json` (mode `0600` where supported). The file
+store is not encrypted; OS keychain integration is not currently implemented.
+For MCP, use `/mcp auth <name> --key-env=ENV_VAR` so the secret itself never
+appears in the command line.
+
+## License
+
+MIT