ratatui/ratatui-core/README.md
Orhun Parmaksız 46902f5587
docs: improve docs for workspace crates (#1490)
Overall makes improvements in the documentation of the workspace crates and checking them.
2024-11-18 02:03:44 +03:00

1.4 KiB

Ratatui Core

Crates.io Documentation License

ratatui-core is the core library of the ratatui project, providing the essential building blocks for creating rich terminal user interfaces in Rust.

Why ratatui-core?

The ratatui-core crate is split from the main ratatui crate to offer better stability for widget library authors. Widget libraries should generally depend on ratatui-core, benefiting from a stable API and reducing the need for frequent updates.

Applications, on the other hand, should depend on the main ratatui crate, which includes built-in widgets and additional features.

Installation

Add ratatui-core to your Cargo.toml:

cargo add ratatui-core

Contributing

We welcome contributions from the community! Please see our CONTRIBUTING guide for more details on how to get involved.

License

This project is licensed under the MIT License. See the LICENSE file for details.