Skip to content

Commit 0b241c4

Browse files
committed
doc improvements, add example images
1 parent d6a26a8 commit 0b241c4

File tree

9 files changed

+35
-81
lines changed

9 files changed

+35
-81
lines changed

Makefile.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,16 @@ dependencies = [
5454
"clippy",
5555
"doc",
5656
]
57+
58+
[tasks.counter-example-svg]
59+
workspace = false
60+
command = "svg-term"
61+
args = [
62+
"--out", "examples/images/counter.svg",
63+
"--window",
64+
"--width", "60",
65+
"--height", "4",
66+
"--no-cursor",
67+
"--command",
68+
"echo '\\033[0;37miocraft\\033[0m % \\033[0;32mcargo\\033[0m run -q --example counter' && timeout 10s cargo run -q --example counter",
69+
]

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ fn main() {
3737
```
3838

3939
Your UI is composed primarily via the `element!` macro, which allows you to
40-
declare your UI elements in a SwiftUI-like syntax.
40+
declare your UI elements in a React/SwiftUI-like syntax.
4141

4242
`iocraft` provides a few built-in components, such as `Box`, `Text`, and
4343
`TextInput`, but you can also create your own using the `#[component]` macro.
@@ -72,8 +72,16 @@ fn main() {
7272

7373
## More Examples
7474

75-
There are many [examples here on GitHub](https://github.com/ccbrown/iocraft/tree/main/examples)
76-
which demonstrate various concepts and how to use all of `iocraft`'s features.
75+
There are many [examples on GitHub](https://github.com/ccbrown/iocraft/tree/main/examples) which
76+
demonstrate various concepts such as tables, progress bars, fullscreen apps,
77+
forms, and more!
78+
79+
## Shoutouts
80+
81+
`iocraft` was inspired by [Dioxus](https://github.com/DioxusLabs/dioxus) and
82+
[Ink](https://github.com/vadimdemedes/ink), which you should also check out,
83+
especially if you're building graphical interfaces or interested in using
84+
JavaScript/TypeScript.
7785

7886
## License
7987

examples/images/counter.svg

Lines changed: 1 addition & 0 deletions
Loading

examples/images/form.png

313 KB
Loading

examples/images/fullscreen.png

395 KB
Loading

examples/images/hello-world.png

181 KB
Loading

examples/images/table.png

403 KB
Loading

packages/iocraft/README.md

Lines changed: 0 additions & 76 deletions
This file was deleted.

packages/iocraft/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../README.md

packages/iocraft/src/lib.rs

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
//! ```
2626
//!
2727
//! Your UI is composed primarily via the [`element!`] macro, which allows you to declare your UI
28-
//! elements in a SwiftUI-like syntax.
28+
//! elements in a React/SwiftUI-like syntax.
2929
//!
3030
//! `iocraft` provides a few built-in components in the [`components`] module, such as
3131
//! [`Box`](crate::components::Box), [`Text`](crate::components::Text), and
@@ -42,7 +42,14 @@
4242
//! ## More Examples
4343
//!
4444
//! There are many [examples on GitHub](https://github.com/ccbrown/iocraft/tree/main/examples)
45-
//! which demonstrate various concepts and how to use all of `iocraft`'s features.
45+
//! which demonstrate various concepts such as tables, progress bars, full screen apps, forms, and
46+
//! more!.
47+
//!
48+
//! ## Shoutouts
49+
//!
50+
//! `iocraft` was inspired by [Dioxus](https://github.com/DioxusLabs/dioxus) and
51+
//! [Ink](https://github.com/vadimdemedes/ink), which you should also check out, especially if
52+
//! you're building graphical interfaces or interested in using JavaScript/TypeScript.
4653
4754
#![warn(missing_docs)]
4855

0 commit comments

Comments
 (0)