From 2a740e2cfce71b035123bd127897a451e3d5c9e5 Mon Sep 17 00:00:00 2001 From: pml68 Date: Thu, 31 Jul 2025 15:09:12 +0200 Subject: feat(docs): add **Features** section to README --- Cargo.toml | 2 +- README.md | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index b017bd9..88d9390 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -12,7 +12,7 @@ rust-version = "1.85" [features] default = ["system-theme"] -# Adds a `System` variant that follows the system theme mode. +# Adds a `System` theme variant that follows the system theme mode. system-theme = ["dep:dark-light"] # Provides `serde` support. serde = ["dep:serde"] diff --git a/README.md b/README.md index da5a1ec..ecc3917 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # material_theme ## A [Material3](https://m3.material.io) inspired custom theme for [`iced`](https://iced.rs) +## Features + +- `default`: `system-theme` +- `system-theme`: Adds a `System` theme variant that follows the system theme mode. +- `serde`: Provides [`serde`](https://docs.rs/serde) support. +- `animate`: Provides support for animating with [`iced_anim`](https://github.com/bradysimon/iced_anim/tree/iced/master). +- `crisp`: Enables pixel snapping for crisp edges by default (can cause jitter!). +- `dialog`: Provides support for [`iced_dialog`](https://github.com/pml68/iced_dialog). +- `markdown`: Provides support for the markdown widget. +- `svg`: Provides support for the SVG widget. +- `qr_code`: Provides support for the QR code widget. -- cgit v1.2.3