Skip to content
This repository has been archived by the owner on Feb 10, 2025. It is now read-only.

Commit

Permalink
feat(docs): README.md: add deprecation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
gekoke committed Feb 10, 2025
1 parent 85e4bc0 commit 03e56e1
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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!

<h1 align="center">
magit-file-icons.el
Expand Down

0 comments on commit 03e56e1

Please sign in to comment.