doc improvements, add example images

ccbrown · Sep 23, 2024 · 0b241c4 · 0b241c4
1 parent d6a26a8
commit 0b241c4
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 81 deletions.
diff --git a/Makefile.toml b/Makefile.toml
@@ -54,3 +54,16 @@ dependencies = [
     "clippy",
     "doc",
 ]
+
+[tasks.counter-example-svg]
+workspace = false
+command = "svg-term"
+args = [
+    "--out", "examples/images/counter.svg",
+    "--window",
+    "--width", "60",
+    "--height", "4",
+    "--no-cursor",
+    "--command",
+    "echo '\\033[0;37miocraft\\033[0m % \\033[0;32mcargo\\033[0m run -q --example counter' && timeout 10s cargo run -q --example counter",
+]
diff --git a/README.md b/README.md
@@ -37,7 +37,7 @@ fn main() {
 ```
 
 Your UI is composed primarily via the `element!` macro, which allows you to
-declare your UI elements in a SwiftUI-like syntax.
+declare your UI elements in a React/SwiftUI-like syntax.
 
 `iocraft` provides a few built-in components, such as `Box`, `Text`, and
 `TextInput`, but you can also create your own using the `#[component]` macro.
@@ -72,8 +72,16 @@ fn main() {
 
 ## More Examples
 
-There are many [examples here on GitHub](https://github.com/ccbrown/iocraft/tree/main/examples)
-which demonstrate various concepts and how to use all of `iocraft`'s features.
+There are many [examples on GitHub](https://github.com/ccbrown/iocraft/tree/main/examples) which
+demonstrate various concepts such as tables, progress bars, fullscreen apps,
+forms, and more!
+
+## Shoutouts
+
+`iocraft` was inspired by [Dioxus](https://github.com/DioxusLabs/dioxus) and
+[Ink](https://github.com/vadimdemedes/ink), which you should also check out,
+especially if you're building graphical interfaces or interested in using
+JavaScript/TypeScript.
 
 ## License
 

diff --git a/examples/images/counter.svg b/examples/images/counter.svg
diff --git a/examples/images/form.png b/examples/images/form.png
diff --git a/examples/images/fullscreen.png b/examples/images/fullscreen.png
diff --git a/examples/images/hello-world.png b/examples/images/hello-world.png
diff --git a/examples/images/table.png b/examples/images/table.png
diff --git a/packages/iocraft/README.md b/packages/iocraft/README.md
diff --git a/packages/iocraft/README.md b/packages/iocraft/README.md
@@ -0,0 +1 @@
+../../README.md
diff --git a/packages/iocraft/src/lib.rs b/packages/iocraft/src/lib.rs
@@ -25,7 +25,7 @@
 //! ```
 //!
 //! Your UI is composed primarily via the [`element!`] macro, which allows you to declare your UI
-//! elements in a SwiftUI-like syntax.
+//! elements in a React/SwiftUI-like syntax.
 //!
 //! `iocraft` provides a few built-in components in the [`components`] module, such as
 //! [`Box`](crate::components::Box), [`Text`](crate::components::Text), and
@@ -42,7 +42,14 @@
 //! ## More Examples
 //!
 //! There are many [examples on GitHub](https://github.com/ccbrown/iocraft/tree/main/examples)
-//! which demonstrate various concepts and how to use all of `iocraft`'s features.
+//! which demonstrate various concepts such as tables, progress bars, full screen apps, forms, and
+//! more!.
+//!
+//! ## Shoutouts
+//!
+//! `iocraft` was inspired by [Dioxus](https://github.com/DioxusLabs/dioxus) and
+//! [Ink](https://github.com/vadimdemedes/ink), which you should also check out, especially if
+//! you're building graphical interfaces or interested in using JavaScript/TypeScript.
 
 #![warn(missing_docs)]