From 7ee776b30fcc032ed0f8c555795c7d31e4f94449 Mon Sep 17 00:00:00 2001 From: rnhmjoj Date: Mon, 25 Mar 2019 00:15:26 +0100 Subject: [PATCH] explain config file in the README --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8a364df..80f80b7 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,32 @@ # Bisc ### A small tool that clears qutebrowser cookies +## Configuration + +The bisc configuration file is `$XDG_CONFIG_HOME/bisc/bisc.conf`. +It allows to change the paths of the QtWebEngine/Chromium +directory and the whitelist file. +The default settings are: +``` +whitelist-path = $(XDG_CONFIG_HOME)/qutebrowser/whitelists/cookies +webengine-path = $(XDG_DATA_HOME)/qutebrowser/webengine +``` + ## Usage -Create the file `$XDG_CONFIG_HOME/qutebrowser/whitelists/cookies` -and write the domains of the allowed cookies, one per line. +Create an empty whitelist file and write the domains of the +allowed cookies, one per line. Eg. ``` .example.com example.com ``` -Run `bisc` to delete all non-whitelisted cookies from qutebrowser. +Run `bisc` to delete all non-whitelisted data from qutebrowser. ## License -Copyright (C) 2018 Michele Guerini Rocco +Copyright (C) 2019 Michele Guerini Rocco This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -29,4 +40,3 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . -