File tree Expand file tree Collapse file tree 1 file changed +18
-2
lines changed
Expand file tree Collapse file tree 1 file changed +18
-2
lines changed Original file line number Diff line number Diff line change @@ -60,7 +60,8 @@ TODO: Add usage instructions
6060
6161## Architecture
6262
63- The architecture of Q is based and highly influenced by the [ WebExtensions APIs] [ webextensions-api ] . There are two main components:
63+ The architecture of Q is based and highly influenced by the [ WebExtensions
64+ APIs] [ webextensions-api ] . There are two main components:
6465
65661 . the browser extension (or add-on),
66672 . the host application.
@@ -79,7 +80,22 @@ the user (see configuration below).
7980
8081## Configuration
8182
82- TODO: Add configuration example
83+ Configuration should be defined in ` $HOME/.config/q/config.toml ` . This file
84+ contains a table of available commands.
85+
86+ Example:
87+
88+ ``` toml
89+ [commands .bookmark ]
90+ label = " Save as a bookmark note"
91+ command = " /home/soulim/.local/share/q/bin/add-bookmark-note"
92+
93+ [commands .demo-script ]
94+ label = " Run a demo script "
95+ command = " /home/soulim/.local/share/q/bin/demo"
96+ ```
97+
98+ NOTE: ` command ` keys must use absolute paths to executables as their values.
8399
84100## Contributing
85101
You can’t perform that action at this time.
0 commit comments