diff --git a/src/lib.rs b/src/lib.rs index 5e3801e..e60655f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,34 @@ +//! **OSUI** โ€“ A Rust Terminal User Interface Library +//! +//! OSUI is a library for building interactive and customizable terminal user interfaces in Rust. +//! It provides a component system, real-time keyboard input handling, and a `rsx!` macro +//! for defining UI elements in a declarative way, however that is optional. +//! +//! โœ… **Features** +//! - ๐Ÿงฑ RSX-like syntax with `rsx!` macro +//! - ๐Ÿ–ฅ๏ธ Virtual screen abstraction +//! - ๐ŸŽน Keyboard input handling +//! - ๐ŸŽฏ Component-based design +//! - โšก Real-time rendering +//! +//! ๐Ÿš€ **Quick Example** +//! ```rust +//! use osui::prelude::*; +//! +//! fn main() -> std::io::Result<()> { +//! let screen = Screen::new(); +//! rsx! { +//! "๐Ÿ‘‹ Hello, World!" +//! }.draw(&screen); +//! screen.run() +//! } +//! ``` +//! +//! --- +//! ๐Ÿงฐ For full documentation, visit: [osui.netlify.app/docs](https://osui.netlify.app/docs) +//! +//! ๐Ÿงช Examples and demos: [github.com/osui-rs/osui/demos](https://github.com/osui-rs/osui/tree/master/src/demos) + use std::sync::{Arc, Mutex}; use crate::{