From 03e56e1ceca54807a6b15229a33fd5c24f6e5d72 Mon Sep 17 00:00:00 2001 From: Gregor Grigorjan Date: Mon, 10 Feb 2025 10:01:28 +0200 Subject: [PATCH] feat(docs): `README.md`: add deprecation notice --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 800a1afe..bae34b24 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ +# Deprecation Notice + +Starting from [223461b](https://github.com/magit/magit/commit/223461b52c35b0f426c053f4c6e7e7637c4a9b73), Magit natively supports custom formatting functions for file entries through the [`magit-format-file-function`](https://github.com/magit/magit/commit/223461b52c35b0f426c053f4c6e7e7637c4a9b73#diff-335d97ddde0824a60d53f17c711216f33e2a27860169fc2e02763781e2ae4779R328) customizable variable. It also ships with pre-defined formatting functions for both `nerd-icons` and `all-the-icons` - rendering this package effectively obsolete. + +Users are encouraged to update `magit` to the latest version and make use of its built-in formatting facilities: + +```elisp +(use-package nerd-icons + :ensure t) + +(use-package magit + :ensure t + :after nerd-icons + :custom + (magit-format-file-function #'magit-format-file-nerd-icons)) +``` + +Thank you, Jonas Bernoulli, for your continued improvements to our favorite Git client!

magit-file-icons.el