Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
matthunz committed Dec 13, 2023
1 parent e580ec7 commit 42c5511
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "concoct"
version = "0.9.0"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "Cross-platform UI framework"
description = "A runtime for user-interfaces"
repository = "https://github.com/concoct-rs/concoct"

[features]
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@

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};

Expand Down Expand Up @@ -65,3 +63,12 @@ async fn main() {
assert_eq!(b.borrow().value, 2);
}
```

## Installation
The easiest way to get started is using the `full` feature flag.

```
cargo add concoct --features full
```

To see a list of the available features flags that can be enabled, check our [docs](https://docs.rs/concoct/latest/concoct/#feature-flags).

0 comments on commit 42c5511

Please sign in to comment.