docs: Mention that root may be needed on macOS

1 files changed, 8 insertions, 0 deletions

diff --git a/deployment/macos/homebrew/bottom.rb.template b/deployment/macos/homebrew/bottom.rb.template
index 0f8a8293..3c9445c3 100644
--- a/deployment/macos/homebrew/bottom.rb.template
+++ b/deployment/macos/homebrew/bottom.rb.template
@@ -18,5 +18,13 @@ class Bottom < Formula
       ohai "For runtime flags, see \"btm --help\""
       ohai "If you want to configure bottom, by default bottom looks for a file in $HOME/Library/Application Support/bottom.toml or $HOME/.config/bottom/bottom.toml"
     end
+
+    def caveats
+      <<~EOS
+        Note that bottom may require elevated privileges to correctly display information for all processes.
+        You can do this with `sudo btm`.
+        You should be certain that you trust any software you grant root privileges.
+      EOS
+    end 
   end
   
\ No newline at end of file