summaryrefslogtreecommitdiff
path: root/fedora/.config/yazi/plugins/full-border.yazi/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'fedora/.config/yazi/plugins/full-border.yazi/README.md')
-rw-r--r--fedora/.config/yazi/plugins/full-border.yazi/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/fedora/.config/yazi/plugins/full-border.yazi/README.md b/fedora/.config/yazi/plugins/full-border.yazi/README.md
new file mode 100644
index 0000000..269ca8e
--- /dev/null
+++ b/fedora/.config/yazi/plugins/full-border.yazi/README.md
@@ -0,0 +1,32 @@
+# full-border.yazi
+
+Add a full border to Yazi to make it look fancier.
+
+![full-border](https://github.com/yazi-rs/plugins/assets/17523360/ef81b560-2465-4d36-abf2-5d21dcb7b987)
+
+## Installation
+
+```sh
+ya pkg add yazi-rs/plugins:full-border
+```
+
+## Usage
+
+Add this to your `init.lua` to enable the plugin:
+
+```lua
+require("full-border"):setup()
+```
+
+Or you can customize the border type:
+
+```lua
+require("full-border"):setup {
+ -- Available values: ui.Border.PLAIN, ui.Border.ROUNDED
+ type = ui.Border.ROUNDED,
+}
+```
+
+## License
+
+This plugin is MIT-licensed. For more information check the [LICENSE](LICENSE) file.