Skip to content

Commit 221075f

Browse files
authored
Merge pull request #179 from multiplex55/codex/update-readme-with-features-and-use-cases
Improve README documentation
2 parents 2afe58b + edff222 commit 221075f

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ Multi Launcher is a lightweight application launcher built with Rust and `eframe
44
It supports configurable hotkeys, basic plugin architecture and file indexing to
55
quickly open applications or files.
66

7+
8+
## Use Cases
9+
10+
- Launch installed applications or custom commands from anywhere using a single hotkey.
11+
- Search your clipboard history or saved bookmarks to quickly paste or open items.
12+
- Run shell commands without opening a terminal.
13+
- Perform web searches or look up documentation directly.
14+
- Jump to frequently used folders with the folders plugin.
15+
16+
717
## Building
818

919
Requirements:
@@ -62,6 +72,10 @@ default hotkey is `F2`. To use a different key, set the `hotkey` value in
6272
"history",
6373
"help"
6474
],
75+
"enabled_capabilities": {"folders": ["search", "show_full_path"]},
76+
"enable_toasts": true,
77+
"fuzzy_weight": 1.0,
78+
"usage_weight": 1.0,
6579
"debug_logging": false,
6680
"offscreen_pos": [2000, 2000],
6781
"window_size": [400, 220],
@@ -105,6 +119,11 @@ includes a *Snapshot* button to capture the current window position and size
105119
for these fields.
106120

107121
`query_scale` and `list_scale` control the size of the search field and the results list separately. Values around `1.0` keep the default look while higher numbers enlarge the respective element up to five times.
122+
`enable_toasts` controls short pop-up notifications when saving settings or commands. Set it to `false` to disable these messages.
123+
`fuzzy_weight` and `usage_weight` adjust how results are ranked. The fuzzy weight multiplies the match score while the usage weight favours frequently launched actions.
124+
`history_limit` defines how many entries the history plugin keeps.
125+
`enabled_capabilities` maps plugin names to capability identifiers so features can be toggled individually. The folders plugin, for example, exposes `show_full_path`.
126+
108127

109128
If you choose `CapsLock` as the hotkey, the launcher suppresses the normal
110129
CapsLock toggle **when compiled with the `unstable_grab` feature enabled**.
@@ -146,6 +165,8 @@ Place the resulting library file in one of the directories listed under
146165

147166
Plugins can be enabled or disabled from the **Settings** window. The list of
148167
active plugins is stored in the `enabled_plugins` section of `settings.json`.
168+
The **Plugin Settings** dialog provides a graphical way to manage plugin directories, enable or disable plugins and toggle capabilities like `show_full_path`.
169+
149170

150171
Example:
151172

@@ -200,6 +221,13 @@ When diagnosing hotkey issues it can be helpful to enable info level logging:
200221
```bash
201222
RUST_LOG=info cargo run
202223
```
224+
## Tips
225+
226+
- Press the help hotkey (F1 by default) to display a quick list of available commands.
227+
- Right click a folder result to set a custom alias for easier access.
228+
- Use the *Snapshot* button in Settings when adjusting static window placement.
229+
- Tweak `fuzzy_weight` and `usage_weight` if you want results to favour name matches or past usage differently.
230+
203231

204232
## Manual Test Plan
205233

0 commit comments

Comments
 (0)