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 4cfb4c5
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@

<h1 align="center">
magit-file-icons.el
magit-file-icons.el <img src="file:https://melpa.org/packages/magit-file-icons-badge.svg"/>
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png" width="800px"/>
</h1>

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://github.com/gekoke/magit-file-icons/releases/latest"><img src="https://img.shields.io/github/tag/gekoke/magit-file-icons.svg?label=release&logo=github&style=for-the-badge" alt="Release tag"></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)
Expand All @@ -15,13 +19,13 @@ Display icons for filenames in ![Magit](https://github.com/magit/magit) buffers!

# Installation

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/).

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 4cfb4c5

Please sign in to comment.