From 7c55d9d8cedff03acc4bcbd0159e9b235f86428d Mon Sep 17 00:00:00 2001 From: Ruslan Date: Thu, 12 Dec 2024 15:47:57 +0200 Subject: [PATCH] docs: add documentation regarding config file --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 31953ec..e4d344f 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ make build-windows make build-darwnin ``` -To run then the binary: +To run the binary: ```bash ./build/adless @@ -93,12 +93,31 @@ but it can be redefined using `--config` flag or the following environment varia - ADLESS_CONFIG_HOME - Specifies the folder where the `config.yml` file is located. - XDG_CONFIG_HOME - Specifies the base directory for user-specific configuration files. Adless will look for `adless/config.yml` within this directory. +### Default configuration + +```yaml +blocklists: + - target: https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts +whitelists: + - target: https://raw.githubusercontent.com/anudeepND/whitelist/master/domains/whitelist.txt +``` + +### Create + To create a local configuration file, run: ```bash adless config init ``` -## TODO: +### Edit + +To open the configuration file in your preferred editor, run: + +```bash +adless config edit +``` + +## TODO 1. Options to add path to local blocklists and whitelists