summaryrefslogtreecommitdiffstats
path: root/examples/todos
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-01-20 07:36:59 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2020-01-20 07:36:59 +0100
commitfd36510807e663813b5fbb7551ae409da154d1cd (patch)
tree061f18733169077502bf25e2d42c63e1615e8fd5 /examples/todos
parent472269580038294b67106aad4e3d1c1117ab9d59 (diff)
downloadiced-fd36510807e663813b5fbb7551ae409da154d1cd.tar.gz
iced-fd36510807e663813b5fbb7551ae409da154d1cd.tar.bz2
iced-fd36510807e663813b5fbb7551ae409da154d1cd.zip
Add `README` for `todos` example
Diffstat (limited to 'examples/todos')
-rw-r--r--examples/todos/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/examples/todos/README.md b/examples/todos/README.md
new file mode 100644
index 00000000..9c2598b9
--- /dev/null
+++ b/examples/todos/README.md
@@ -0,0 +1,20 @@
+## Todos
+
+A todos tracker inspired by [TodoMVC]. It showcases dynamic layout, text input, checkboxes, scrollables, icons, and async actions! It automatically saves your tasks in the background, even if you did not finish typing them.
+
+All the example code is located in the __[`main`]__ file.
+
+<div align="center">
+ <a href="https://gfycat.com/littlesanehalicore">
+ <img src="https://thumbs.gfycat.com/LittleSaneHalicore-small.gif" height="400px">
+ </a>
+</div>
+
+You can run the native version with `cargo run`:
+```
+cargo run --package todos
+```
+We have not yet implemented a `LocalStorage` version of the auto-save feature. Therefore, it does not work on web _yet_!
+
+[`main`]: src/main.rs
+[TodoMVC]: http://todomvc.com/