Skip to content

Commit 08c09de

Browse files
committed
Update docs
1 parent d4b5fbd commit 08c09de

File tree

5 files changed

+17
-12
lines changed

5 files changed

+17
-12
lines changed

README.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Vonal global search
22

3-
![Preview](./preview.png)
4-
53
Vonal is a modern alternative to `dmenu`, `rofi`, `albert` etc...
64
Ideal for tiling window managers.
75

@@ -29,35 +27,42 @@ Build from source (Rust is required):
2927

3028
<small>(They have to be called from the same directory.)</small>
3129

32-
If you use bspwm, an example rule to keep Vonal floating:
33-
`bspc rule -a vonal state=floating border=off`
30+
*Optionally*: If you use **bspwm**, an example rule to keep Vonal floating:
31+
- `bspc rule -a vonal state=floating border=off`
3432

35-
## The current state
33+
# Plugins
3634

37-
Currently, there are 3 plugins:
35+
## launcher_plugin
36+
![Preview](./docs/app-launcher-plugin.png)
3837

39-
- **Application launcher (launcher_plugin):** A fuzzy search for .desktop files and executables in $PATH, supporting sub-actions
38+
A fuzzy search for .desktop files and executables in $PATH, supporting sub-actions
4039
- trigger: anything
4140
- shortcuts:
4241
- Up, Down, Left, Right, Enter
4342
- example commands:
4443
- `chr` finds chromium
4544
- `chr github.com` finds chromium and on enter, it opens it with `github.com`
4645
- `,` is for settings like reload application cache
47-
- **Calculator (math_plugin):** a python proxy
46+
## math_plugin
47+
![Preview](./docs/math-plugin.png)
48+
49+
A python proxy
4850
- trigger: `=`
4951
- example commands:
5052
- `= sin(radians(90))` prints `1.0`
5153
- `= [i for i in range(1000) if i %99 == 0]` shows the numbers between 0 and 999 that are dividable by 99
52-
- **Password manager (pass_plugin):** A configurable password manager plugin. It works with every password managers, however, the default config is only for GNU pass. This is not meant to be used from the search menu although you can reach it that way as well.
54+
## pass_plugin
55+
![Preview](./docs/password-manager-plugin.png)
56+
57+
A configurable password manager plugin. It works with every password managers, however, the default config is only for GNU pass. This is not meant to be used from the search menu although you can reach it that way as well.
5358
- suggested binding: `super+p` `vonalc set_query "pass " show`
5459
- trigger: `pass`
5560
- example commands:
5661
- `pass fa` list every account name containing "fa"
5762

5863
Warning: On update you have to manually enable new plugins.
5964

60-
## Vonal Client Commands (vonalc)
65+
# CLI
6166

6267
Synopsis: `vonalc commandA arg1 arg2 commandB arg1 ...`
6368

@@ -66,12 +71,12 @@ Synopsis: `vonalc commandA arg1 arg2 commandB arg1 ...`
6671
- `toggle`: show/hide the window
6772
- `set_query "something"`: writes the word "something" to the searchbar.
6873

69-
## Configuration
74+
# Configuration
7075

7176
The configuration file is created on the fly to `~/.config/vonal/config.toml`.
7277
You can see every existing config options, there.
7378

74-
## Contribution
79+
# Contribution
7580

7681
Please let me know if you would like to use it. It would motivate me to work on the project.
7782
Open any issues about new ideas. Tell me what plugins would you want to see.

docs/app-launcher-plugin.png

35.1 KB
Loading

docs/math-plugin.png

15.6 KB
Loading

docs/password-manager-plugin.png

15 KB
Loading

preview.png

-15.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)