Skip to content

Commit

Permalink
More readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
lampsitter committed Sep 13, 2023
1 parent 562dd71 commit 5ea29ee
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ Github's markdown syntax: tables, strikethrough, tasklists and footnotes.

## Usage

In `Cargo.toml` add the following:

```toml
egui_commonmark = "0.8"

# If you don't need image loading you can ignore the dependencies below.

# Specify the the ways you want to load images, check egui_extras features
# for more info. Or use the feature "all-loaders" if you don't care.
egui_extras = { version = "<to-be-released>", features = ["image", "files"] }
Expand All @@ -36,8 +42,6 @@ CommonMarkViewer::new("viewer").show(ui, &mut cache, markdown);

* `syntax_highlighting`: Syntax highlighting inside code blocks with
[`syntect`](https://crates.io/crates/syntect)
* `svg`: Support for viewing svg images
* `fetch`: Images with urls will be downloaded and displayed

## License

Expand Down

0 comments on commit 5ea29ee

Please sign in to comment.