Skip to content

Commit 3245075

Browse files
committed
Add pass_plugin and vonalc to readme
1 parent a8935f7 commit 3245075

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

+17-3
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,35 @@ If you use bspwm, an example rule to keep Vonal floating:
2020

2121
## The current state
2222

23-
Currently, there are 2 plugins:
23+
Currently, there are 3 plugins:
2424

25-
- **Application launcher plugin:** A fuzzy search for .desktop files and executables in $PATH, supporting sub-actions
25+
- **Application launcher (launcher_plugin):** A fuzzy search for .desktop files and executables in $PATH, supporting sub-actions
2626
- trigger: anything
2727
- shortcuts:
2828
- Up, Down, Left, Right, Enter
2929
- example commands:
3030
- `chr` finds chromium
3131
- `chr github.com` finds chromium and on enter, it opens it with `github.com`
3232
- `,` is for settings like reload application cache
33-
- **Calculator plugin:** a python proxy
33+
- **Calculator (math_plugin):** a python proxy
3434
- trigger: `=`
3535
- example commands:
3636
- `= sin(radians(90))` prints `1.0`
3737
- `= [i for i in range(1000) if i %99 == 0]` shows the numbers between 0 and 999 that are dividable by 99
38+
- **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.
39+
- suggested binding: `super+p` `vonalc set_query pass_plugin show`
40+
- trigger: `pass_plugin`
41+
42+
Warning: On update you have to manually enable new plugins.
43+
44+
## Vonal Client Commands (vonalc)
45+
Synopsis: `vonalc commandA arg1 arg2 commandB arg1 ...`
46+
47+
- `show`: show the window
48+
- `hide`: hide the window
49+
- `toggle`: show/hide the window
50+
- `set_query "something"`: writes the word "something" to the searchbar.
51+
3852

3953
## Configuration
4054
The configuration file is created on the fly to `~/.config/vonal/config.toml`.

0 commit comments

Comments
 (0)