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 a7d0d8c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,25 @@

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/v/tag/gekoke/magit-file-icons.svg?label=release&sort=semver&color=pink&style=for-the-badge" alt="Version"/></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
You can install this package from [MELPA](https://melpa.org/#/magit-file-icons).

This package is not yet in any package archives. To install, you need to fetch the source.

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
2 changes: 1 addition & 1 deletion magit-file-icons.el
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
;; Created: 14 May 2024

;; URL: https://github.com/gekoke/magit-file-icons
;; Package-Version: 0.2.5
;; Package-Version: 1.0.0
;; Package-Requires: ((emacs "24.3") (magit "3.3.0") (nerd-icons "0.1.0") (el-patch "3.1"))

;; This program is free software; you can redistribute it and/or modify
Expand Down
2 changes: 1 addition & 1 deletion nix/packages.nix
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ _: {

magit-file-icons = pkgs.emacsPackages.trivialBuild rec {
pname = "magit-file-icons";
version = "v0.2.5";
version = "v1.0.0";

src = ../.;

Expand Down

0 comments on commit a7d0d8c

Please sign in to comment.