From 2c90f9e4fd48b9bd8a6fe428ac9e97114e235efe Mon Sep 17 00:00:00 2001 From: Polesznyák Márk Date: Tue, 21 Oct 2025 10:23:54 +0200 Subject: docs(README): add some new sections, extend existing ones --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index f5b6ff6..a828598 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,10 @@ [![builds.sr.ht status](https://builds.sr.ht/~pml68/iced_selection.svg)](https://builds.sr.ht/~pml68/iced_selection)   [![docs](https://img.shields.io/website?url=https%3A%2F%2Ficed-selection.pml68.dev&label=docs)](https://iced-selection.pml68.dev) - ## Text selection API for [`iced`](https://iced.rs), with reference widget implementations. +Text in iced currently isn't selectable except for `TextEditor` and `TextInput`. This is my solution, but others exist as well (see [Special thanks](#special-thanks)). + Check out the examples, or read the [documentation](https://iced-selection.pml68.dev) to get an idea about the crate. Roughly: @@ -15,7 +16,22 @@ Roughly: - `markdown.rs`: A custom [`Viewer`](https://docs.iced.rs/iced/widget/markdown/trait.Viewer.html) and its corresponding custom methods. - `lib.rs`: Helper methods, macros and re-exports. +## Installation +Simply add it to under your `Cargo.toml`'s `dependencies` section. +```toml +# ... + +[dependencies] +iced = { git = "https://github.com/iced-rs/iced", branch = "master" } +iced_selection = { git = "https://git.sr.ht/~pml68/iced_selection" } +``` + ## Features - `default`: - `markdown`: Provides support for rendering markdown through a custom viewer. + +## Special thanks + +- [`iced`](https://iced.rs), for making this possible in the first place, and for the modified source code of `Text`, `Rich` and `Selection` (based on [`text_input/cursor.rs`](https://github.com/iced-rs/iced/blob/master/widget/src/text_input/cursor.rs)). +- [`Halloy`](https://halloy.chat), for its amazing selectable text implementation (check it out, but mind the GPLv3!). -- cgit v1.2.3