From 19e89de5d914ded63e25d64118243fd9299b6ad5 Mon Sep 17 00:00:00 2001 From: Ben Busby Date: Sun, 24 Oct 2021 00:17:38 -0600 Subject: [PATCH] Expand on "features" section of readme The "no JS" and "no cookies" portions of the readme warranted further explanation. Since Whoogle uses JS and server-side cookies, it might be confusing to a passerby what is actually meant by this. Note that both JS and cookies can be blocked and Whoogle will still be able to perform searches perfectly well. Also updated the "theme" feature description --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8522da8..e8ff31e 100644 --- a/README.md +++ b/README.md @@ -39,9 +39,9 @@ Contents ## Features - No ads or sponsored content -- No JavaScript -- No cookies -- No tracking/linking of your personal IP address\* +- No JavaScript\* +- No cookies\*\* +- No tracking/linking of your personal IP address\*\*\* - No AMP links - No URL tracking tags (i.e. utm=%s) - No referrer header @@ -49,14 +49,18 @@ Contents - Autocomplete/search suggestions - POST request search and suggestion queries (when possible) - View images at full res without site redirect (currently mobile only) -- Dark mode +- Light/Dark/System theme modes (with support for [custom CSS theming](https://github.com/benbusby/whoogle-search/wiki/User-Contributed-CSS-Themes)) - Randomly generated User Agent - Easy to install/deploy - DDG-style bang (i.e. `! `) searches - Optional location-based searching (i.e. results near \) -- Optional NoJS mode to disable all Javascript in results +- Optional NoJS mode to view search results in a separate window with JavaScript blocked -*If deployed to a remote server, or configured to send requests through a VPN, Tor, proxy, etc. +*No third party JavaScript. Whoogle can be used with JavaScript disabled, but if enabled, uses JavaScript for things like presenting search suggestions. + +**No third party cookies. Whoogle uses server side cookies (sessions) to store non-sensitive configuration settings such as theme, language, etc. Just like with JavaScript, cookies can be disabled and not affect Whoogle's search functionality. + +***If deployed to a remote server, or configured to send requests through a VPN, Tor, proxy, etc. ## Dependencies If using Heroku Quick Deploy, **you can skip this section**.