Add showcase

Cargo.toml

@@ -3,6 +3,12 @@ name = "egui_commonmark"
 authors = ["Erlend Walstad"]
 version = "0.1.0"
 edition = "2021"
+description = "Commonmark viewer for egui"
+keywords = ["commonmark", "egui"]
+license = "MIT OR Apache-2.0"
+readme = "README.md"
+repository = "https://github.com/lampsitter/egui_commonmark"
+exclude = ["assets/"]
 
 [dependencies]
 # Depend on master until next release
@@ -26,3 +32,6 @@ svg = ["resvg", "usvg", "tiny-skia"]
 
 # Fetch images over http
 fetch = ["ehttp", "url", "image/jpeg"]
+
+[dev-dependencies]
+eframe = { git = "https://github.com/emilk/egui" }

README.md

@@ -1,8 +1,11 @@
-A commonmark viewer for [egui](https://github.com/emilk/egui)
+# A commonmark viewer for [egui](https://github.com/emilk/egui)
 
 [![CI](https://github.com/lampsitter/egui_commonmark/actions/workflows/rust.yml/badge.svg)](https://github.com/lampsitter/egui_commonmark/actions/workflows/rust.yml)
 
-# Usage
+<img src="https://raw.githubusercontent.com/lampsitter/egui_commonmark/example/assets/example.png" alt="showcase" width=300/>
+
+## Usage
+
 ```rust
 use egui_commonmark::*;
 let markdown =

examples/basic.rs

@@ -0,0 +1,60 @@
+//! Make sure to run this example from the repo directory and not the example
+//! directory. To see all the features in full effect, run this example with
+//! `cargo r --example basic --all-features`
+
+use eframe::{egui, epi};
+use egui_commonmark::*;
+
+struct App {
+    cache: CommonMarkCache,
+}
+
+impl epi::App for App {
+    fn name(&self) -> &str {
+        "Markdown viewer"
+    }
+
+    fn update(&mut self, ctx: &egui::Context, _frame: &epi::Frame) {
+        let text = r#"# Commonmark Viewer example
+
+A *little* ~~paragraph~~ __with__ `multiple` styles.
+
+| __A table!__ |
+| -------- |
+| ![Rust logo](examples/rust-logo-128x128.png) |
+| Some filler text |
+| [Link to repo](https://github.com/lampsitter/egui_commonmark) |
+
+```rs
+let mut vec = Vec::new();
+vec.push(5);
+```
+
+> Some smart quote here
+
+- [ ] A feature[^1]
+- [X] A completed feature
+    1. Sub item
+
+[^1]: A footnote
+            "#;
+
+        egui::CentralPanel::default().show(ctx, |ui| {
+            egui::ScrollArea::vertical().show(ui, |ui| {
+                CommonMarkViewer::new("viewer")
+                    .max_image_width(Some(512))
+                    .show(ui, &mut self.cache, text);
+            });
+        });
+    }
+}
+
+fn main() {
+    let options = eframe::NativeOptions::default();
+    eframe::run_native(
+        Box::new(App {
+            cache: CommonMarkCache::default(),
+        }),
+        options,
+    );
+}

examples/rust-logo-license

@@ -0,0 +1 @@
+Logo from https://github.com/rust-lang/rust-artwork