From aef8b84c6f6efdcb738da3b3a37d4e8afc114ef1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Teodor=20K=C3=A4llman?=
 <94024065+RedPhoenixQ@users.noreply.github.com>
Date: Sat, 19 Oct 2024 11:59:00 +0200
Subject: [PATCH] Add docs for feature flags (#333)

---
 src/lib.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index e5865303..ec0cc1a1 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -116,6 +116,12 @@
 //! $ inferno-diff-folded folded2 folded1 | inferno-flamegraph --negate > diff1.svg
 //! ```
 //!
+//! # Feature flags
+//! All features below are enabled by default
+//! - `cli`: Also builds the `inferno` command-line tools
+//! - `multithreaded`: Enables multithreaded stack-collapsing
+//! - `nameattr`: Allows for adding customizing and adding attributes to the svg of [`flamegraph`]. See the `--nameattr` option for the flamegraph cli
+//!
 //! # Development
 //!
 //! This crate was initially developed through [a series of live coding sessions]. If you want to