summaryrefslogtreecommitdiffstats
path: root/glutin/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'glutin/README.md')
-rw-r--r--glutin/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/glutin/README.md b/glutin/README.md
new file mode 100644
index 00000000..addb9228
--- /dev/null
+++ b/glutin/README.md
@@ -0,0 +1,29 @@
+# `iced_glutin`
+[![Documentation](https://docs.rs/iced_glutin/badge.svg)][documentation]
+[![Crates.io](https://img.shields.io/crates/v/iced_glutin.svg)](https://crates.io/crates/iced_glutin)
+[![License](https://img.shields.io/crates/l/iced_glutin.svg)](https://github.com/hecrj/iced/blob/master/LICENSE)
+[![project chat](https://img.shields.io/badge/chat-on_zulip-brightgreen.svg)](https://iced.zulipchat.com)
+
+`iced_glutin` offers some convenient abstractions on top of [`iced_native`] to quickstart development when using [`glutin`].
+
+It exposes a renderer-agnostic `Application` trait that can be implemented and then run with a simple call. The use of this trait is optional. A `conversion` module is provided for users that decide to implement a custom event loop.
+
+<p align="center">
+ <img alt="The native target" src="../docs/graphs/native.png" width="80%">
+</p>
+
+[documentation]: https://docs.rs/iced_glutin
+[`iced_native`]: ../native
+[`glutin`]: https://github.com/rust-windowing/glutin
+
+## Installation
+Add `iced_glutin` as a dependency in your `Cargo.toml`:
+
+```toml
+iced_glutin = "0.1"
+```
+
+__Iced moves fast and the `master` branch can contain breaking changes!__ If
+you want to learn about a specific release, check out [the release list].
+
+[the release list]: https://github.com/hecrj/iced/releases