diff --git a/README.md b/README.md index 55cd1e5..5ae2653 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ # osui -A TUI library written in rust! + +`osui` is a Text User Interface (TUI) library written in Rust. + +## Features + +- **Cross-Platform Support**: Works on various operating systems. +- **Flexible Layout**: Easily create and manage complex UIs. +- **Efficient Performance**: Designed for high performance and low latency. + +## Installation + +To use `osui` in your Rust project, add the following to your `Cargo.toml`: + +```toml +[dependencies] +osui = "^0.0.1" +``` + +```rust +use osui::{self, ui}; + +fn main() { + osui::clear(); + let mut txt = ui::text("hello, world!"); + txt.render(); +} +``` +