diff --git a/README.md b/README.md index a42fca8..acf80ee 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,16 @@ # Bisc -### A small tool that clears qutebrowser cookies +### A small tool that clears cookies (and more) + +Websites can store unwanted data using all sorts of methods: besides +the usual cookies, there are also the local and session storage, the +IndexedDB API and more caches as well. + +bisc will try to go through each of them and remove all information from +websites that are not explicitly allowed (ie. a whitelist of domains). +It was created for qutebrowser, but it actually supports the storage +format used by Chromium-based browsers, which (sadly) means almost +every one nowadays. ## Installation @@ -23,8 +33,6 @@ Finally, statically compiled binaries can be found in the [cabal]: https://github.com/haskell/cabal/blob/master/cabal-install/README.md [stack]: https://docs.haskellstack.org/en/stable/README/ - - ## Configuration The bisc configuration file is `$XDG_CONFIG_HOME/bisc/bisc.conf`. @@ -48,6 +56,10 @@ example.com Run `bisc` to delete all non-whitelisted data from qutebrowser. +Note that running bisc while the browser is open is not safe: meaning it +could possibly corruption the databases. However, it has never happened +or has been reported to me. + ## License Copyright (C) 2021 Michele Guerini Rocco @@ -59,7 +71,7 @@ the Free Software Foundation, either version 3 of the License, or This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License