Skip to content

Commit 1807bd0

Browse files
Merge pull request #397 from RtlZeroMemory/edit-readme
Refine README positioning
2 parents 83e23d0 + 2d16a77 commit 1807bd0

7 files changed

Lines changed: 19 additions & 19 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,31 @@
22

33
> **Status: pre-alpha.** Rezi is under active development. Public APIs, native ABI details, and behavior may change between releases. It is not yet recommended for production workloads.
44
5-
Rezi is a TypeScript framework for deterministic, native-backed terminal applications on Node.js and Bun. It provides a declarative widget API, predictable input and rendering behavior, and a rendering pipeline powered by the [Zireael engine](https://github.com/RtlZeroMemory/Zireael) written in C.
5+
Rezi is a TypeScript framework for building serious terminal applications on Node.js and Bun. It gives you structured layout, focus and input handling, routing, widgets, testing tools, and a native-backed rendering pipeline powered by the [Zireael engine](https://github.com/RtlZeroMemory/Zireael) written in C.
66

77
**Links:** [Website](https://rezitui.dev/) · [Docs](https://rezitui.dev/) · [Quickstart](https://rezitui.dev/getting-started/quickstart/) · [Widgets](https://rezitui.dev/widgets/) · [Benchmarks](https://rezitui.dev/benchmarks/)
88

99
![Rezi command console demo](assets/REZICONSOLE3.gif)
1010

1111
## What Rezi Is For
1212

13-
Rezi is aimed at terminal applications that need more than line-oriented output: multi-panel layouts, routed screens, focusable controls, forms, tables, overlays, testing support, and predictable behavior under keyboard and mouse input.
13+
Rezi is aimed at dashboards, control planes, internal tools, log viewers, and developer workflows that need more than line-oriented output: multi-panel layouts, routed screens, focusable controls, forms, tables, overlays, testing support, and predictable behavior under keyboard and mouse input.
1414

1515
## Why Rezi
1616

17-
- Declarative application structure without requiring React
18-
- Deterministic render and input contracts for testable TUI workflows
17+
- Structured app model for real TUI workflows
18+
- Declarative widget API without requiring React
1919
- Native-backed framebuffer diffing and terminal output through Zireael
20-
- First-party widgets for real app surfaces: forms, tables, overlays, routing, charts, and command flows
21-
- Behavior-first test utilities for rendering, routing, focus, and terminal scenarios
20+
- First-party widgets for forms, tables, overlays, routing, charts, and command flows
21+
- Reproducible rendering and input contracts for behavior-first tests
2222

2323
## What Rezi Includes
2424

2525
- Layout primitives for rows, columns, grids, panels, spacing, and layered screens
2626
- Interactive widgets such as buttons, inputs, selects, checkboxes, radios, sliders, tabs, tables, virtual lists, trees, dialogs, dropdowns, and toasts
2727
- Graphics and data-display widgets including canvas, charts, gauges, sparklines, heatmaps, and image support
2828
- Application primitives for focus management, keybindings, routing, theming, and controlled state updates
29-
- Testing utilities and deterministic rendering behavior intended to make TUI code easier to verify
29+
- Testing utilities for render assertions, routing and focus behavior, and replayable input workflows
3030
- A native-backed rendering path through Zireael for layout, framebuffer diffing, and terminal output
3131

3232
## Example
@@ -87,9 +87,9 @@ bun run start
8787

8888
## Public Templates
8989

90-
- `minimal` - small single-screen starter
91-
- `cli-tool` - routed multi-screen workflow starter
92-
- `starship` - polished command-console showcase with routing, charts, canvas, forms, and overlays
90+
- `minimal` - small single-screen starter for focused utilities
91+
- `cli-tool` - routed multi-screen starter for product-style terminal tools
92+
- `starship` - larger command-console showcase with routing, charts, canvas, forms, and overlays
9393

9494
## Starship Demo
9595

packages/core/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@rezi-ui/core",
33
"version": "0.1.0-alpha.61",
4-
"description": "Runtime-agnostic TypeScript core for Rezi (widgets, layout, routing, drawlists, event parsing).",
4+
"description": "Runtime-agnostic TypeScript core for building structured Rezi terminal applications.",
55
"license": "Apache-2.0",
66
"homepage": "https://rezitui.dev",
77
"repository": {

packages/create-rezi/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "create-rezi",
33
"version": "0.1.0-alpha.61",
4-
"description": "Scaffold a Rezi terminal UI app.",
4+
"description": "Scaffold a Rezi terminal application from focused starter and showcase templates.",
55
"license": "Apache-2.0",
66
"homepage": "https://rezitui.dev",
77
"repository": {

packages/create-rezi/src/scaffold.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const TEMPLATE_DEFINITIONS: readonly TemplateDefinition[] = [
1818
{
1919
key: "minimal",
2020
label: "Minimal Utility TUI",
21-
description: "Single-screen starter for focused tools",
21+
description: "Small single-screen starter for focused terminal utilities",
2222
safetyTag: "safe-default",
2323
safetyNote: "Small-footprint template for quick utility workflows.",
2424
highlights: [
@@ -30,7 +30,7 @@ export const TEMPLATE_DEFINITIONS: readonly TemplateDefinition[] = [
3030
{
3131
key: "cli-tool",
3232
label: "Multi-Screen CLI Tool",
33-
description: "Multi-screen CLI starter with first-party routing",
33+
description: "Routed starter for product-style terminal tools",
3434
safetyTag: "safe-default",
3535
safetyNote: "Lightweight template focused on product workflows and routing.",
3636
highlights: [
@@ -42,12 +42,12 @@ export const TEMPLATE_DEFINITIONS: readonly TemplateDefinition[] = [
4242
{
4343
key: "starship",
4444
label: "Starship Command Console",
45-
description: "Polished multi-deck showcase for routing, animation, charts, forms, and overlays",
45+
description: "Larger command-console showcase for routing, animation, charts, forms, and overlays",
4646
safetyTag: "safe-default",
4747
safetyNote:
4848
"Feature-rich showcase template with moderate CPU usage from animation hooks and live telemetry.",
4949
highlights: [
50-
"six-screen bridge with routing, animated gauges, live telemetry charts, and crew management",
50+
"six-screen command console with routing, animated gauges, live telemetry charts, and crew management",
5151
"command palette, modal dialogs, toast notifications, forms, split panes, canvas, and theme cycling with keybinding modes",
5252
],
5353
dir: "starship",

packages/create-rezi/templates/starship/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Scaffolded with `create-rezi` using the **__TEMPLATE_LABEL__** template.
44

55
## Concept
66

7-
`__APP_NAME__` is a multi-deck starship operations console. It demonstrates routed application architecture, deterministic telemetry simulation, rich widgets, layered overlays, and declarative animation hooks in a single advanced template.
7+
`__APP_NAME__` is a multi-deck starship operations console. It demonstrates routed application architecture, live telemetry simulation, rich widgets, layered overlays, and declarative animation hooks in a single advanced template.
88

99
This template is intentionally larger than the default starters. Use it as a showcase, reference app, or screenshot target; use `minimal` or `cli-tool` when you want a smaller starting point.
1010

packages/node/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@rezi-ui/node",
33
"version": "0.1.0-alpha.61",
4-
"description": "Node.js/Bun backend for Rezi (worker-thread engine ownership, scheduling, IO).",
4+
"description": "Node.js/Bun backend for running Rezi terminal applications with native engine integration.",
55
"license": "Apache-2.0",
66
"homepage": "https://rezitui.dev",
77
"repository": {

packages/testkit/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@rezi-ui/testkit",
33
"version": "0.1.0-alpha.61",
4-
"description": "Test utilities and fixtures for Rezi.",
4+
"description": "Test utilities and fixtures for Rezi terminal applications.",
55
"license": "Apache-2.0",
66
"homepage": "https://rezitui.dev",
77
"repository": {

0 commit comments

Comments
 (0)