1 files changed, 21 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f5b6ff6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# iced_selection
+
+[![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.
+
+Check out the examples, or read the [documentation](https://iced-selection.pml68.dev) to get an idea about the crate.
+
+Roughly:
+- `selection.rs`: The main selection API, built around iced's [`Paragraph`](https://docs.iced.rs/iced_graphics/text/paragraph/struct.Paragraph.html).
+- `text.rs`: Reference implementation for a selectable text widget.
+    - `text/rich.rs`: Reference implementation for a selectable rich text widget.
+- `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.
+
+## Features
+
+- `default`:
+- `markdown`: Provides support for rendering markdown through a custom viewer.