Skip to content

Commit

Permalink
docs: update readme with info about fancy feature
Browse files Browse the repository at this point in the history
  • Loading branch information
zkat committed Sep 22, 2021
1 parent 468843a commit f92c75f
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ but it's definitely a bug and should be reported.
diagnostic error code: ruget::api::bad_json
" />

**NOTE: You must enable the `"fancy"` crate feature to get fancy report output
like in the screenshots here.** You should only do this in your toplevel
crate, as the fancy feature pulls in a number of dependencies that libraries
and such might not want.

## Table of Contents <!-- omit in toc -->

- [About](#about)
Expand Down Expand Up @@ -232,6 +237,11 @@ pub fn some_tool() -> Result<Version> {
`Result` as your return value, and it will pretty-print your
diagnostics automatically.

**NOTE: You must enable the `"fancy"` crate feature to get fancy report output
like in the screenshots here.** You should only do this in your toplevel
crate, as the fancy feature pulls in a number of dependencies that libraries
and such might not want.

```rust
use miette::{Result, IntoDiagnostic};
use semver::Version;
Expand Down

0 comments on commit f92c75f

Please sign in to comment.