Skip to content

docs: fix broken README usage examples #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dreyfus92 merged 1 commit into from
Jul 8, 2026
Merged

docs: fix broken README usage examples #109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,16 +117,13 @@ To render this:
```

```typescript
import { close, createTerm, grow, open, rgba, text } from "@bomb.sh/tty";
import { close, createTerm, open, rgba, text } from "@bomb.sh/tty";

let term = await createTerm({ width: 80, height: 24 });

let { output } = term.render([
open("root", {
layout: { width: grow(), height: grow(), direction: "ttb" },
}),
open("greeting", {
layout: { padding: { left: 1, right: 1 } },
layout: { padding: { left: 1, right: 1, top: 1, bottom: 1 } },
border: {
color: rgba(0, 255, 0),
left: 1,
Expand All @@ -138,7 +135,6 @@ let { output } = term.render([
}),
text("Hello, World!"),
close(),
close(),
]);

process.stdout.write(output);
Expand All @@ -150,6 +146,10 @@ Pass pointer state to `render()` to have `@bomb.sh/tty` do hit detection and
return pointer events in addition to the byte sequence.

```typescript
import { close, createTerm, fixed, grow, open, rgba, text } from "@bomb.sh/tty";

let term = await createTerm({ width: 80, height: 24 });

let { output, events } = term.render(
[
open("root", {
Expand Down Expand Up @@ -186,7 +186,7 @@ process.stdout.write(output);
### Input parsing

```typescript
import { createInput } from "@bomb.sh/tty/input";
import { createInput } from "@bomb.sh/tty";

let input = await createInput({ escLatency: 25 });

Expand Down
Loading