From f92c75f17672659f55d34f4dc62fdc6c0d59ea20 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kat=20March=C3=A1n?= <kzm@zkat.tech>
Date: Wed, 22 Sep 2021 16:36:41 -0700
Subject: [PATCH] docs: update readme with info about fancy feature

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

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 <!-- omit in toc -->
 
 - [About](#about)
@@ -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;