From f6145b59c3d3666d21a898d91aa477ab14985603 Mon Sep 17 00:00:00 2001
From: yokoffing <11689349+yokoffing@users.noreply.github.com>
Date: Fri, 30 Sep 2022 15:03:14 -0400
Subject: [PATCH] configs explainer
---
README.md | 16 +++++++++-------
1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 65daeb5..485a740 100644
--- a/README.md
+++ b/README.md
@@ -19,21 +19,23 @@ about:config tweaks to enhance [Mozilla Firefox](https://www.mozilla.org/en-US/f
## Simple configs
-
+
| List | Description |
|:---------:|-------------|
| [Fastfox](https://github.com/yokoffing/BetterFox/blob/master/FastFox.js) | Immensely increase Firefox's browsing speed. Give Chrome a run for its money!|
-| [SecureFox](https://github.com/yokoffing/BetterFox/blob/master/SecureFox.js) | Remove Telemetry, Mozilla experiments, Google Safe Browsing, and search engine suggestions in URL bar. Auto-upgrade mixed content to HTTPS. Various privacy enhancements. |
-| [PeskyFox](https://github.com/yokoffing/BetterFox/blob/master/PeskyFox.js) | Unclutter the new tab page. Remove Pocket and form autofill. Prevent Firefox from serving annoying webpage notifications. |
-| [SmoothFox](https://github.com/yokoffing/BetterFox/blob/master/SmoothFox.js) | Get Microsoft Edge-like smooth scrolling on your favorite browser. |
+| [Securefox](https://github.com/yokoffing/BetterFox/blob/master/SecureFox.js) | Remove Telemetry, Mozilla experiments, Google Safe Browsing, and search engine suggestions in URL bar. Auto-upgrade mixed content to HTTPS. Various privacy enhancements. |
+| [Peskyfox](https://github.com/yokoffing/BetterFox/blob/master/PeskyFox.js) | Unclutter the new tab page. Remove Pocket and form autofill. Prevent Firefox from serving annoying webpage notifications. |
+| [Smoothfox](https://github.com/yokoffing/BetterFox/blob/master/SmoothFox.js) | Get Microsoft Edge-like smooth scrolling on your favorite browser. |
| [user.js](https://github.com/yokoffing/BetterFox/blob/master/user.js) | All the essentails. None of the breakage. Users may download this list as their own user.js. |
-| [LibreWolf.Overrides.cfg](https://github.com/yokoffing/BetterFox/blob/master/librewolf.overrides.cfg) | Do you prefer [LibreWolf](https://librewolf.net/)? Well, here's a few [overrides](https://librewolf.net/docs/settings/) to enhance your favorite Firefox fork! |
+| [librewolf.overrides.cfg](https://github.com/yokoffing/BetterFox/blob/master/librewolf.overrides.cfg) | Do you prefer [LibreWolf](https://librewolf.net/)? Well, here's a few [overrides](https://librewolf.net/docs/settings/) to enhance your favorite Firefox fork! |
+
+:bulb: `Fastfox`, `Securefox`, `Peskyfox`, and `Smoothfox` are guides to relevant prefs in Firefox. The `user.js` is curated from the prefs located in these documents, so just because a pref is in one of the guides doesn't mean it is included in the final document, the `user.js`. Please use the descriptions and references as a guide for the prefs in Firefox, and open a [feature request](https://github.com/yokoffing/BetterFox/issues/new/choose) if you think one can be improved upon.
## Who is this setup for?
-**If you want a secure, blazing fast browsing experience, and don't want to deal with breakage, this setup is for you.** My objective is to make the defaults sufficient enough for the average privacy-minded user, but remain trouble-free enough that my grandmother could use it. (That puts a whole new twist on being a foxy grandma!) Edit: Sorry for the dad joke 😓
+**If you want a secure, blazing fast browsing experience, and don't want to deal with breakage, this setup is for you.** The objective is to make the defaults sufficient enough for the average privacy-minded user, but remain trouble-free enough that my grandmother could use it. (That puts a whole new twist on being a foxy grandma!) Edit: Sorry for the dad joke 😓
## about:Privacy
-My guiding principle was: "If it breaks it, it doesn't make it!" So things like WebGL and DRM are still enabled, and you won't find a setting like `privacy.resistFingerprinting` mentioned here ([why?](https://old.reddit.com/r/firefox/comments/wuqpgi/are_there_any_aboutconfig_tweaks_to_get_smooth/ile3whx/?context=3)). BetterFox is designed to set-and-forget, not to troubleshoot and tinker. You can compare different user.js files [here](https://jm42.github.io/compare-user.js).
+The guiding principle is: "If it breaks it, it doesn't make it!" So things like WebGL and DRM are still enabled, and you won't find a setting like `privacy.resistFingerprinting` mentioned here ([why?](https://old.reddit.com/r/firefox/comments/wuqpgi/are_there_any_aboutconfig_tweaks_to_get_smooth/ile3whx/?context=3)). BetterFox is designed to set-and-forget, not to troubleshoot and tinker. You can compare different user.js files [here](https://jm42.github.io/compare-user.js).
BetterFox was created with a [less is more](https://medium.com/the-mission/less-is-more-the-minimum-effective-dose-e6d56625931e) mentality (i.e., keeping in mind [the law of diminishing returns](https://www.investopedia.com/terms/l/lawofdiminishingmarginalreturn.asp)). Most repos I've encountered have niche privacy and security concerns with little regard for speed, annoyances, or mainstream use. The average user doesn't need all `prefs` altered to get the results they want.