From 71d10bc3315b2d44ba1d21f81cd5dd1d2689289b Mon Sep 17 00:00:00 2001 From: Leo dev Date: Sat, 30 Nov 2024 11:18:26 +0100 Subject: [PATCH] small readme change --- README.md | 26 ++------------------------ 1 file changed, 2 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index f61c0a1..6355cb6 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ OSUI is a customizable terminal user interface (TUI) library written in Rust. It provides a set of components and rsx to build interactive command-line interfaces with ease.

+## [Documentation](https://osui.netlify.app/docs) + ## Features - Custom rsx syntax. @@ -28,30 +30,6 @@ - Create complex layouts using nested elements. - Customizable element sizes and styles. -## Getting Started - -```bash -cargo add osui -``` - -## Example Usage - -Here’s a simple example of how to create a basic UI with OSUI: - -```rust -use osui::prelude::*; - -fn main() { - run(&mut rsx! { - text { "Hello, World!" } - }); -} -``` - -## How it works -Credit to priz.js (discord) for the idea of using C for multithreading - - ## Contributing Contributions are welcome! If you have suggestions or improvements, feel free to submit a pull request or open an issue.