feat(docs): add README.md

gekoke · May 15, 2024 · 48daaa5 · 48daaa5
1 parent b09919a
commit 48daaa5
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# magit-file-icons.el
+
+Display file icons in Magit!
+
+# Preview
+![Magit status buffer with file icons](./screenshots/status.png)
+
+![Magit revision diffstat with file icons](./screenshots/diffstat.png)
+
+# Installation
+
+This package is not yet in any package archives.
+
+To install, fetch the source and 
+
+For example, with [straight.el](https://github.com/radian-software/straight.el):
+
+```elisp
+(use-package magit-file-icons
+  :straight (:host github :repo "gekoke/magit-file-icons")
+  :custom
+  ;; These are the default values:
+  (magit-file-icons-enable-diff-file-section-icons t)
+  (magit-file-icons-enable-untracked-icons t)
+  (magit-file-icons-enable-diffstat-icons t)
+  :config
+  (magit-file-icons-mode 1))
+```
+
+# Usage
+
diff --git a/screenshots/diffstat.png b/screenshots/diffstat.png
diff --git a/screenshots/status.png b/screenshots/status.png