Skip to content

Commit 317c69f

Browse files
committed
Add a configuration example
1 parent b810fd4 commit 317c69f

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff 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

6566
1. the browser extension (or add-on),
6667
2. 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

0 commit comments

Comments
 (0)