aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Alexey Stepanov <blueingreen@bluig.space>2024-09-27 14:04:46 +0500
committerLibravatar Alexey Stepanov <blueingreen@bluig.space>2024-09-27 14:04:46 +0500
commit2adf045d6c672920aefa9cecf97339b9f843f0aa (patch)
tree83893a5568ca27fe60431a95babd8acc3fcd8dee
parentb256a8f6cef9434f0b28a0d2d06d3bd6aa8b9d7e (diff)
update
- add link on source in config file; - add Usage block in README.md.
-rw-r--r--README.md10
-rw-r--r--examples/config.yaml2
2 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 433d128..b899008 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,16 @@ All files in `colors` directory generated by [lustache](https://luarocks.org/mod
![Example nwg-dock with base16-google-light colorscheme](./examples/img/google-light.png)
+## Usage
+
+You can find an example config in `examples/config.yaml`.
+
+Run `wlr-which-key` with this config:
+
+```bash
+wlr-which-key config.yaml
+```
+
## License
MIT
diff --git a/examples/config.yaml b/examples/config.yaml
index 661e45e..d7f8e2d 100644
--- a/examples/config.yaml
+++ b/examples/config.yaml
@@ -1,3 +1,5 @@
+# source: https://github.com/MaxVerevkin/wlr-which-key/tree/master#configuration
+#
font: JetBrainsMono Nerd Font 16
separator: " ➜ "
border_width: 2