diff --git a/README.md b/README.md index 54ba261..209acc8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ # OSUI - A Terminal User Interface (TUI) Library -OSUI is a customizable terminal user interface (TUI) library written in Rust. It provides a set of components to build interactive command-line interfaces with ease. +
+
## Contributing
diff --git a/github/OSUI.png b/github/OSUI.png
new file mode 100644
index 0000000..d5278b6
Binary files /dev/null and b/github/OSUI.png differ
diff --git a/github/multithread.png b/github/multithread.png
new file mode 100644
index 0000000..a556882
Binary files /dev/null and b/github/multithread.png differ
diff --git a/src/lib.rs b/src/lib.rs
index 82821f2..96c8f02 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -10,7 +10,7 @@
//! ```rust
//! use osui::prelude::*;
//!
-//! osui::app::run(&mut rsx! {
+//! run(&mut rsx! {
//! text { "Hello, World!" }
//! });
//! ```
@@ -39,17 +39,9 @@ pub mod utils;
pub mod prelude {
pub use crate::ui::Color::*;
pub use crate::{app::run, css, rsx, rsx_elem, ui::*, Handler};
- pub use crate::{Children, Element, ElementCore, State, Value};
- pub use crossterm::event::{Event, KeyCode, KeyEvent, KeyEventKind};
- pub fn sleep(ms: u64) {
- std::thread::sleep(std::time::Duration::from_millis(ms));
- }
-}
-
-pub mod prelude_extra{
- pub use crate::ui::Color::*;
- pub use crate::{app::run, css, rsx, rsx_elem, ui::*, Handler, StateChanger};
- pub use crate::{Children, Component, Element, ElementCore, State, Value, run_handler};
+ pub use crate::{Element, State, StateChanger, Value};
+ // useful for Element making
+ pub use crate::{run_handler, Children, Component, ElementCore};
pub use crossterm::event::{Event, KeyCode, KeyEvent, KeyEventKind};
pub fn sleep(ms: u64) {
std::thread::sleep(std::time::Duration::from_millis(ms));
diff --git a/src/ui/mod.rs b/src/ui/mod.rs
index db37aa1..e645ee9 100644
--- a/src/ui/mod.rs
+++ b/src/ui/mod.rs
@@ -5,7 +5,7 @@
pub mod styles;
pub use styles::*;
-use crate::prelude_extra::*;
+use crate::prelude::*;
use osui_element::{elem_fn, element};
/// The `Text` element represents a piece of static text in the terminal UI.