small readme update'

This commit is contained in:
2024-09-17 20:44:17 +02:00
parent 4e135f92e4
commit 44b7cfe035
+28 -1
View File
@@ -1,2 +1,29 @@
# osui # 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();
}
```