From 324507509a9a212a57c2c65f8319635e90dcf8a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20Bir=C3=B3?= Date: Mon, 24 Apr 2023 00:29:15 +0200 Subject: [PATCH] Add pass_plugin and vonalc to readme --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 249284c..f09d6d4 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,9 @@ If you use bspwm, an example rule to keep Vonal floating: ## The current state -Currently, there are 2 plugins: +Currently, there are 3 plugins: -- **Application launcher plugin:** A fuzzy search for .desktop files and executables in $PATH, supporting sub-actions +- **Application launcher (launcher_plugin):** A fuzzy search for .desktop files and executables in $PATH, supporting sub-actions - trigger: anything - shortcuts: - Up, Down, Left, Right, Enter @@ -30,11 +30,25 @@ Currently, there are 2 plugins: - `chr` finds chromium - `chr github.com` finds chromium and on enter, it opens it with `github.com` - `,` is for settings like reload application cache -- **Calculator plugin:** a python proxy +- **Calculator (math_plugin):** a python proxy - trigger: `=` - example commands: - `= sin(radians(90))` prints `1.0` - `= [i for i in range(1000) if i %99 == 0]` shows the numbers between 0 and 999 that are dividable by 99 +- **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. + - suggested binding: `super+p` `vonalc set_query pass_plugin show` + - trigger: `pass_plugin` + +Warning: On update you have to manually enable new plugins. + +## Vonal Client Commands (vonalc) +Synopsis: `vonalc commandA arg1 arg2 commandB arg1 ...` + +- `show`: show the window +- `hide`: hide the window +- `toggle`: show/hide the window +- `set_query "something"`: writes the word "something" to the searchbar. + ## Configuration The configuration file is created on the fly to `~/.config/vonal/config.toml`.