summaryrefslogtreecommitdiff
path: root/fedora/.config/yazi/flavors/kanagawa.yazi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fedora/.config/yazi/flavors/kanagawa.yazi/README.md')
-rw-r--r--fedora/.config/yazi/flavors/kanagawa.yazi/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/fedora/.config/yazi/flavors/kanagawa.yazi/README.md b/fedora/.config/yazi/flavors/kanagawa.yazi/README.md
new file mode 100644
index 0000000..d314236
--- /dev/null
+++ b/fedora/.config/yazi/flavors/kanagawa.yazi/README.md
@@ -0,0 +1,36 @@
+<div align="center">
+ <img src="https://github.com/sxyazi/yazi/blob/main/assets/logo.png?raw=true" alt="Yazi logo" width="20%">
+</div>
+
+<h3 align="center">
+ Kanagawa Flavor for <a href="https://github.com/sxyazi/yazi">Yazi</a>
+</h3>
+
+## 👀 Preview
+
+<img src="preview.png" width="600" />
+
+## 🎨 Installation
+
+```bash
+ya pkg add dangooddd/kanagawa
+```
+
+## ⚙️ Usage
+
+> [!Note]
+> To achieve the look like in the screenshot you also need to install
+> [full-border](https://github.com/yazi-rs/plugins/tree/main/full-border.yazi) plugin!
+
+Add these lines to your `theme.toml` configuration file to use it:
+
+```toml
+[flavor]
+dark = "kanagawa"
+```
+
+## 📜 License
+
+The flavor is MIT-licensed, and the included tmTheme is also MIT-licensed.
+
+Check the [LICENSE](LICENSE) and [LICENSE-tmtheme](LICENSE-tmtheme) file for more details.