From 1ae3e51728486f4dab25c013909d1927c428fb27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Ram=C3=B3n=20Jim=C3=A9nez?= Date: Sun, 28 Jul 2019 13:31:38 +0200 Subject: [PATCH] Improve README --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a13b348b..8c3f4d3e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,12 @@ [![Crates.io](https://img.shields.io/crates/v/iced.svg)](https://crates.io/crates/iced) [![License](https://img.shields.io/crates/l/iced.svg)](https://github.com/hecrj/iced/blob/master/LICENSE) -An opinionated GUI runtime for Rust, heavily inspired by Elm. +An GUI runtime for Rust, heavily inspired by Elm. + +[![GUI][gui_gif]][gui_gfycat] + +[gui_gif]: https://thumbs.gfycat.com/GloomyWeakHammerheadshark-small.gif +[gui_gfycat]: https://gfycat.com/gloomyweakhammerheadshark ## Features * Simple, easy to use API @@ -92,3 +97,20 @@ impl Counter { } } ``` + +Browse the [documentation] and the [examples] to learn more! + +[documentation]: https://docs.rs/iced +[examples]: https://github.com/hecrj/iced/tree/master/examples + +## Implementation details +Iced is heavily inspired by [Elm], a delightful language for reliable webapps. +It brings the reactive programming model of [The Elm Architecture] into Rust +without introducing weak references or runtime errors. + +Iced also uses [Stretch], an implementation of Flexbox written in Rust, to +perform all the layouting. + +[Elm]: https://elm-lang.org/ +[The Elm Architecture]: https://guide.elm-lang.org/architecture/ +[Stretch]: https://github.com/vislyhq/stretch