Skip to content

Commit

Permalink
docs: update to show difference between terminalizer and default rend…
Browse files Browse the repository at this point in the history
…erer
  • Loading branch information
iamogbz committed Dec 9, 2024
1 parent d277aae commit 1e7838d
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Install from the github repo
npm i -g 'github:iamogbz/animaterm'
```

> You do not need the peer dependencies except you need to render in the `gif` format
>
> The terminalizer (`tlz`) renderer produces better gifs but requires an additional dependency
>
> TODO: support rendering fancy console text colors and formatting
Run the `animaterm` bin with cli options

```sh
Expand All @@ -36,7 +42,7 @@ Step[]

That is a `JSON` array at the root where each `Step` is defined by the following interface:

https://github.com/iamogbz/animaterm/blob/50f983c/src/types.d.ts#L49-L83
https://github.com/iamogbz/animaterm/blob/d277aae/src/types.d.ts#L49-L83

#### Descriptions

Expand Down Expand Up @@ -70,7 +76,7 @@ Wait for data in `payload` to be displayed in the terminal

Defined by the interface `Config`:

https://github.com/iamogbz/animaterm/blob/50f983c/src/types.d.ts#L1-L35
https://github.com/iamogbz/animaterm/blob/d277aae/src/types.d.ts#L1-L35

> TODO: add instructions on overriding the default config
Expand Down

1 comment on commit 1e7838d

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generated Image

Please sign in to comment.