diff --git a/Cargo.toml b/Cargo.toml index f2daa2ee..3df7bb2c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "concoct" -version = "0.8.0-alpha.3" +version = "0.9.0" edition = "2021" license = "MIT OR Apache-2.0" description = "Cross-platform UI framework" diff --git a/README.md b/README.md index 1b1492ec..03da513a 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ Concoct is a runtime for user-interfaces in Rust. +To see a list of the available features flags that can be enabled, check our [docs](https://docs.rs/concoct/latest/concoct/#feature-flags). + ```rust use concoct::{Context, Handler, Object, Runtime, Signal}; diff --git a/src/lib.rs b/src/lib.rs index 59b6fb06..44be74f8 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,14 @@ +//! # Concoct +//! +//! ## Feature flags +//! Concoct uses a set of feature flags to provide support for #![no_std] +//! (and to reduce the amount of compiled code). +//! +//! - `full`: Enables all features listed below. +//! - `rt`: Enables the [`Runtime`]. +//! - `futures`: Enables interop with the `futures` crate (and provides the default `Runtime`). +//! + #![cfg_attr(not(feature = "std"), no_std)] #![cfg_attr(docsrs, feature(doc_cfg))]