@bettertui/core 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026, Localfirstai Inc.
+
+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

@@ -0,0 +1,57 @@
+# @bettertui/core
+
+**Framework-agnostic command protocol, tree manipulation, reconciler wrapper, and runtime.** Framework package for vanilla / native TypeScript. No React dependency.
+
+## Overview
+
+`@bettertui/core` is the public entry point for building terminal UIs without React. It provides:
+
+- **Command protocol** — typed `Command` union and `CommandBuffer` for batching
+- **Reconciler** — `createReconciler(buffer)` wraps tree ops with command emission
+- **Runtime** — `CommandRuntime` owns the buffer, frame loop, and subscriber dispatch
+- **Native bridge** — loads `bettertui_engine.node` addon, exposes engine factories
+- **DevTools** — in-core debug tooling (`createDevTools`, debug overlay)
+- **Testing utilities** — `createTestRenderer`, `createMockKeys`, mock streams, spies
+- **Keymap** — framework-agnostic input binding engine
+- **Widgets** — TypeScript widget option types
+- **Validation** — `validate`, `warnIfInvalid`, layout/style validation
+
+## Installation
+
+```bash
+npm install @bettertui/core
+```
+
+Requires building the native Rust addon for native bridge features:
+
+```bash
+pnpm --filter @bettertui/core build:native
+```
+
+## Quick start
+
+```ts
+import { createEngine, detectCapabilities, CliRenderer } from "@bettertui/core";
+
+const engine = createEngine();
+const caps = detectCapabilities();
+```
+
+## Re-exports
+
+Re-exports all types from `@bettertui/shared` (internal — don't install separately).
+
+## Features
+
+- Framework-agnostic (no React dependency)
+- Native Rust engine via napi-rs FFI
+- Command-batched rendering (one FFI call per frame)
+- In-core DevTools with debug overlay
+- Testing utilities for headless rendering
+- Keymap with layered bindings, chord sequences, and modes
+
+## Related Documentation
+
+- [Architecture overview](../../docs/architecture/overview.md)
+- [API reference](../../docs/api/packages/core.md)
+- [Guides](../../docs/guides/getting-started.md)