diff --git a/README.md b/README.md index 84f1b7a..63bcb21 100644 --- a/README.md +++ b/README.md @@ -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 - [About](#about) @@ -232,6 +237,11 @@ pub fn some_tool() -> Result { `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;