summaryrefslogtreecommitdiff
path: root/xplr/plugins/dragon/README.md
diff options
context:
space:
mode:
authorzachir <zachir@librem.one>2022-10-05 22:00:32 -0500
committerzachir <zachir@librem.one>2022-10-05 22:00:32 -0500
commitf39d735e2ba625a31a7dbf6fb8bdd62501379ad1 (patch)
treed17c96714c930e0b8bc75616cc9c81b961ed5aa0 /xplr/plugins/dragon/README.md
Initial Commit
Diffstat (limited to 'xplr/plugins/dragon/README.md')
-rw-r--r--xplr/plugins/dragon/README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/xplr/plugins/dragon/README.md b/xplr/plugins/dragon/README.md
new file mode 100644
index 0000000..8a74a12
--- /dev/null
+++ b/xplr/plugins/dragon/README.md
@@ -0,0 +1,49 @@
+[![xplr-dragon.gif](https://s6.gifyu.com/images/xplr-dragon.gif)](https://gifyu.com/image/A8N1)
+
+Drag and drop files using [dragon](https://github.com/mwh/dragon).
+
+
+Requirements
+------------
+
+- [dragon](https://github.com/mwh/dragon)
+- [curl](https://github.com/curl/curl)
+
+
+Installation
+------------
+
+### Install manually
+
+- Add the following line in `~/.config/xplr/init.lua`
+
+ ```lua
+ package.path = os.getenv("HOME") .. '/.config/xplr/plugins/?/src/init.lua'
+ ```
+
+- Clone the plugin
+
+ ```bash
+ mkdir -p ~/.config/xplr/plugins
+
+ git clone https://github.com/sayanarijit/dragon.xplr ~/.config/xplr/plugins/dragon
+ ```
+
+- Require the module in `~/.config/xplr/init.lua`
+
+ ```lua
+ require("dragon").setup()
+
+ -- Or
+
+ require("dragon").setup{
+ mode = "selection_ops",
+ key = "D",
+ drag_args = "",
+ drop_args = "",
+ keep_selection = false,
+ }
+
+ -- Select files and type `:sD` to drag
+ -- Type `:sD` without selecting anything to drop
+ ```