From 2adf045d6c672920aefa9cecf97339b9f843f0aa Mon Sep 17 00:00:00 2001 From: Alexey Stepanov Date: Fri, 27 Sep 2024 14:04:46 +0500 Subject: update - add link on source in config file; - add Usage block in README.md. --- README.md | 10 ++++++++++ examples/config.yaml | 2 ++ 2 files changed, 12 insertions(+) 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 -- cgit