aboutsummaryrefslogtreecommitdiff
path: root/dotfiles/.config/noctalia/plugins/file-search/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'dotfiles/.config/noctalia/plugins/file-search/README.md')
-rw-r--r--dotfiles/.config/noctalia/plugins/file-search/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/dotfiles/.config/noctalia/plugins/file-search/README.md b/dotfiles/.config/noctalia/plugins/file-search/README.md
new file mode 100644
index 0000000..1d5ef34
--- /dev/null
+++ b/dotfiles/.config/noctalia/plugins/file-search/README.md
@@ -0,0 +1,25 @@
+# File Search Plugin
+
+File search from the launcher.
+
+## Requirements
+
+This plugin requires [fd](https://github.com/sharkdp/fd#installation) to be installed.
+
+## Usage
+
+**Access from launcher:**
+
+Type `>file` in the Noctalia launcher to activate file search.
+
+**Toggle file search:**
+
+```bash
+noctalia-shell ipc call plugin:file-search toggle
+```
+
+**Search with pre-filled query:**
+
+```bash
+noctalia-shell ipc call plugin:file-search search "eko"
+```