Skip to content

Commit

Permalink
feat(docs): README.md: update information for MELPA release
Browse files Browse the repository at this point in the history
  • Loading branch information
gekoke committed May 20, 2024
1 parent 6cc31ee commit 0637615
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,26 @@

Display icons for filenames in ![Magit](https://github.com/magit/magit) buffers!

<img src="https://img.shields.io/github/actions/workflow/status/gekoke/magit-file-icons/ci.yaml?style=for-the-badge"/>
<div>
<a href="https://github.com/gekoke/magit-file-icons/actions"><img src="https://img.shields.io/github/actions/workflow/status/gekoke/magit-file-icons/ci.yaml?style=for-the-badge" alt="Build status"/></a>
<a href="https://opensource.org/license/gpl-3-0"><img src="https://img.shields.io/badge/license-GPLv3-orange.svg?style=for-the-badge" alt="License"></a>
</div>

# Preview
![Magit status buffer with file icons](./screenshots/status.png)

![Magit revision diffstat with file icons](./screenshots/diffstat.png)

# Installation
<a href="https://melpa.org/#/magit-file-icons"><img src="https://melpa.org/packages/magit-file-icons-badge.svg" alt="magit-file-icons badge"/></a>

This package is not yet in any package archives. To install, you need to fetch the source.
You can install this package from [MELPA](https://melpa.org/#/magit-file-icons).

For example, with [straight.el](https://github.com/radian-software/straight.el):
For example, with `use-package`:

```elisp
(use-package magit-file-icons
:straight (:host github :repo "gekoke/magit-file-icons")
:ensure t
:custom
;; These are the default values:
(magit-file-icons-enable-diff-file-section-icons t)
Expand Down

0 comments on commit 0637615

Please sign in to comment.