@utsp/render 0.17.3 → 0.17.4

package/README.md

@@ -1,130 +1,43 @@
-# @utsp/render
-
-> ⚠️ **PROTOTYPE - NOT READY FOR PRODUCTION**
->
-> This package is currently in early development and should **NOT** be used in production.
-> The API is unstable and subject to breaking changes without notice.
+<div align="center">
 
-Rendering system for UTSP (Universal Tile Stream Protocol) - Terminal character rendering with WebGL, Canvas 2D, and ANSI terminal support.
+# @utsp/render
 
+[![NPM Version](https://img.shields.io/npm/v/@utsp/render.svg)](https://www.npmjs.com/package/@utsp/render)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## Features
-
-- **TerminalGL** - High-performance WebGL 1.0 renderer with GPU palette
-- **Terminal2D** - CPU-based Canvas 2D fallback renderer
-- **TerminalANSI** - ANSI escape sequence renderer for native terminals (cmd, PowerShell, bash)
-- **Tree-shakeable** - Import only what you need for smaller bundles
-- **Overlays** - AutoplayOverlay, PostProcessOverlay, GridOverlay
-
-## Installation
-
-```bash
-npm install @utsp/render
-```
-
-## Entry Points
-
-The package provides multiple entry points for optimal bundle size:
-
-### Full Bundle (default)
-```typescript
-import { TerminalGL, Terminal2D, AutoplayOverlay } from '@utsp/render';
-```
-
-### WebGL Only (~43 KB)
-```typescript
-import { TerminalGL, ScalingMode } from '@utsp/render/gl';
-```
-
-### Canvas 2D Only (~27 KB)
-```typescript
-import { Terminal2D, BitmapFontAtlas } from '@utsp/render/2d';
-```
-
-### Common Utilities Only (~11 KB)
-```typescript
-import { AutoplayOverlay, PostProcessOverlay, GridOverlay } from '@utsp/render/common';
-```
+Visit [**UTSP.dev**](https://utsp.dev/) for more information.
 
-### ANSI Terminal (~3 KB)
-```typescript
-import { TerminalANSI } from '@utsp/render/ansi';
-```
+</div>
 
-## Quick Start
+---
 
-### WebGL Renderer (recommended)
-```typescript
-import { TerminalGL, ScalingMode } from '@utsp/render/gl';
+The **Rendering Engine** for UTSP. It provides multiple backends to transform UTSP display data into visual pixels, with high performance and retro-inspired aesthetics.
 
-const terminal = new TerminalGL(container, {
-  cols: 80,
-  rows: 24,
-  scalingMode: ScalingMode.Integer
-});
+> [!WARNING]
+> **PROTOTYPE - NOT READY FOR PRODUCTION**
+> This package is under active development. The API is unstable and subject to breaking changes.
 
-// Load bitmap font
-await terminal.loadBitmapFont(fontData, 8, 8);
-
-// Update cells from Core
-terminal.render(core.getDisplayBuffer());
-```
-
-### Canvas 2D Renderer (fallback)
-```typescript
-import { Terminal2D } from '@utsp/render/2d';
-
-const terminal = new Terminal2D(container, {
-  fixedCols: 80,
-  fixedRows: 24
-});
-
-// Render from Core
-terminal.render(core.getDisplayBuffer());
-```
+> [!NOTE]
+> **Source Code Availability**
+> While this package is licensed under MIT, the source code is currently being finalized for public release. It will be available on GitHub in the coming months.
 
-### ANSI Terminal Renderer (for CLI apps)
-```typescript
-import { TerminalANSI } from '@utsp/render/ansi';
+## ✨ Features
 
-const renderer = new TerminalANSI({
-  optimizeColors: true,  // Only emit color codes when they change
-  hideCursor: true       // Hide cursor during rendering
-});
+- **🚀 Multi-backend**: WebGL & Canvas2D support.
+- **🎨 Post-Processing**: Built-in scanlines and other effects.
+- **🔡 Font Atlas**: Efficient bitmap font management.
+- **🖥️ Responsive Scaling**: Flexible viewport management.
 
-// Render from Core's RenderState
-const output = renderer.render(renderState);
-process.stdout.write(output);
+## 📦 Installation
 
-// Cleanup on exit
-process.stdout.write(renderer.showCursor() + renderer.reset());
+```bash
+npm install @utsp/render
 ```
 
-## Bundle Sizes
-
-| Entry Point | ESM (minified) | ESM (gzip) |
-|-------------|----------------|------------|
-| `@utsp/render` | 74.43 KB | 18.40 KB |
-| `@utsp/render/gl` | 43.49 KB | 11.03 KB |
-| `@utsp/render/2d` | 27.24 KB | 7.83 KB |
-| `@utsp/render/common` | 11.19 KB | 3.46 KB |
-
-## ⚠️ Development Status
-
-**This is a prototype package under active development.**
-
-- ❌ No stable API
-- ❌ Breaking changes expected
-- ❌ Not recommended for production use
-
-**Please check back later for updates or watch the repository for release announcements.**
-
-## Repository
+## 📖 Documentation
 
-- [GitHub](https://github.com/thp-software/utsp)
-- [Issues](https://github.com/thp-software/utsp/issues)
+For detailed guides on the protocol and application development, visit the official [**Documentation**](https://docs.utsp.dev/introduction).
 
-## License
+## 📄 License
 
-MIT © 2025 THP Software
+MIT © 2026 [THP Software](https://github.com/thp-software)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@utsp/render",
-  "version": "0.17.3",
+  "version": "0.17.4",
   "description": "UTSP Render - Rendering engine for terminal graphics with WebGL, Canvas 2D, and ANSI terminal support",
   "author": "THP Software",
   "license": "MIT",
@@ -86,7 +86,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@utsp/types": "0.17.3"
+    "@utsp/types": "0.17.4"
   },
   "devDependencies": {
     "typescript": "^5.6.3"