summaryrefslogtreecommitdiffstats
path: root/src/lib.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-08-28 06:45:39 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-08-28 06:45:39 +0200
commit8758dd446f25553049b6dd2ab9be0007febb4877 (patch)
treeab43af4c5ef6027ed5effb44534e4d2429a296fa /src/lib.rs
parent5dbcf211ef1a157586454bd5316ef3f7f93018c4 (diff)
downloadiced-8758dd446f25553049b6dd2ab9be0007febb4877.tar.gz
iced-8758dd446f25553049b6dd2ab9be0007febb4877.tar.bz2
iced-8758dd446f25553049b6dd2ab9be0007febb4877.zip
Write more documentation
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/lib.rs b/src/lib.rs
index d4089ac8..9dab0470 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,12 +1,12 @@
-//! Iced is a simple GUI runtime for Rust, heavily inspired by [Elm].
+//! Iced is a renderer-agnostic GUI library for Rust focused on simplicity and
+//! type-safety. Inspired by [Elm].
//!
//! # Features
-//! * Simple, easy-to-use API
+//! * Simple, easy-to-use, renderer-agnostic API
//! * Responsive, flexbox-based layouting
//! * Type-safe, reactive programming model
-//! * Many built-in widgets
+//! * Built-in widgets
//! * Custom widget support
-//! * Renderer-agnostic runtime
//!
//! Check out the [repository] and the [examples] for more details!
//!
@@ -43,8 +43,8 @@
//! }
//! ```
//!
-//! Now that we have state, what are the user interactions we care about? The
-//! button presses! These are our __messages__:
+//! Now that we have state... When will it change? When either button is pressed!
+//! These user interactions are our __messages__:
//!
//! ```
//! #[derive(Debug, Clone, Copy)]
@@ -139,7 +139,7 @@
//! }
//! ```
//!
-//! Finally, we need to be able to react to the __messages__ and mutate our
+//! Finally, we need to be able to react to the __messages__ and change our
//! __state__ accordingly in our __update logic__:
//!
//! ```