@zaly/tui 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Folke Lemaitre
+
+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,59 @@
+# @zaly/tui
+
+Terminal UI framework used by zaly.
+
+`@zaly/tui` is a direct-mode terminal renderer with stream, UI, and overlay
+surfaces; reactive widgets; markdown/code/diff rendering; mouse selection;
+clipboard helpers; themes; and terminal graphics support.
+
+> [!WARNING]
+> Alpha package. Public APIs are not frozen.
+
+## Install
+
+```sh
+bun add @zaly/tui
+```
+
+Most users should install [`@zaly/cli`](../cli) instead.
+
+## Highlights
+
+- **Renderer surfaces** — scrollable stream, pinned UI/footer, and overlay layer.
+- **Widgets** — text, box, markdown, code, diff, image, input, select/tree,
+  picker, progress, spinner, log, and autocomplete building blocks.
+- **Selection** — mouse selection in fullscreen mode, copy-friendly text
+  extraction, word/line selection, and app-level selection events.
+- **Terminal graphics** — Kitty Graphics Protocol support with capability
+  detection, unicode placeholders where supported, direct placement fallback,
+  and tmux passthrough handling.
+- **Themes** — ANSI/style builder, theme registry, and syntax highlighting
+  integration.
+- **Runtime split** — works in Bun and Node through package exports/import maps.
+
+## Minimal example
+
+```ts
+import { createRenderer, input, markdown } from "@zaly/tui"
+
+const renderer = await createRenderer()
+
+renderer.stream.append(markdown("# hello from zaly/tui"))
+renderer.ui.add(
+  input({ placeholder: "say something…" }).on("submit", (value, self) => {
+    renderer.stream.append(markdown(`**you:** ${value}`))
+    self.setState({ cursor: 0, value: "" })
+  })
+)
+
+renderer.start()
+```
+
+## Notes
+
+This package is built for zaly first. It is usable on its own, but API names and
+widget behavior may change while the app evolves.
+
+## License
+
+MIT © Folke Lemaitre