diff --git a/README.md b/README.md index 2cf0f89..a20c8c0 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ betterlockscreen --lock blur - [how it works](#how-it-works) - [requirements](#requirements) - [installation](#installation) +- [configuration](#configuration) - [usage](#usage) - [background](#set-desktop-background-on-startup) - [keybinding](#keybindings) @@ -95,6 +96,12 @@ export PATH="${PATH}:${HOME}/.local/bin/" UtkarshVerma was so kind to provide an installation script for debian based systems, ![check it out here](https://github.com/UtkarshVerma/installer-scripts). +### Configuration + +You can customise various colors for betterlockscreen, copy config file from examples directory to `~/.config/betterlockscreenrc` and edit it accordingly. + +If configuration file is not found then default configurations will be used. + ### Usage Run `betterlockscreen` and point it to either a directory (`betterlockscreen -u "path/to/dir"`) or an image (`betterlockscreen -u "/path/to/img.jpg"`) and that's all. `betterlockscreen` will change update its cache with image you provided. @@ -172,6 +179,8 @@ exec --no-startup-id source ~/.fehbg ### Keybindings +To lockscreen using keyboard shortcut + #### i3wm Add this line to your `~/.config/i3/config`