mirror of
				https://github.com/arkenfox/user.js.git
				synced 2025-11-04 07:45:26 +01:00 
			
		
		
		
	Up Up Down Down Left Right Left Right B A Start
This commit is contained in:
		
				
					committed by
					
						
						GitHub
					
				
			
			
				
	
			
			
			
						parent
						
							dc6246ca8f
						
					
				
				
					commit
					be8ff2268d
				
			
							
								
								
									
										42
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										42
									
								
								README.md
									
									
									
									
									
								
							@@ -1,18 +1,13 @@
 | 
			
		||||
###  Foreword
 | 
			
		||||
What started as a personal, private project back in early 2015, was released as an article by Martin Brinkmann at [ghacks](https://www.ghacks.net/) in August 2015. I never expected much to happen beyond the first article, but it did. The response from the ghacks community was great. I continued to keep it up-to-date and expand it. And along with suggestions from ghacks commentators, it has evolved and grown. But six-monthly updates are problematic. So two years since I started, here we are at github, with all the obvious benefits that brings. I am excited about finally being here (it was talked about for a year), and looking forward to taking this to the next level with you all.
 | 
			
		||||
###  What does this do?
 | 
			
		||||
For a technical breakdown and explanation, check out the [Overview](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.1-Overview) in our awesome Wiki.
 | 
			
		||||
 | 
			
		||||
Thorin-Oakenpants, 31-Mar-2017
 | 
			
		||||
As for this particular [`user.js`](https://github.com/ghacksuserjs/ghacks-user.js/blob/master/user.js), it's a template, which, as provided, aims (with [add-ons](https://github.com/ghacksuserjs/ghacks-user.js/wiki/Appendix-B:-Firefox-Add-ons)) to provide as much privacy and enhanced security as possible, and to reduce tracking and fingerprinting as much as possible - while minimizing any loss of functionality and site or UI breakage (but it will happen).
 | 
			
		||||
 | 
			
		||||
PS: With Martin Brinkmann's blessing, we are keeping the ghacks name.
 | 
			
		||||
 | 
			
		||||
###  What does this aim to do?
 | 
			
		||||
This `user.js` is a template, which, as given, aims (with add-ons) to provide as much privacy and enhanced security as possible, and to reduce tracking and fingerprinting as much as possible - while minimizing any loss of functionality and site or UI breakage (but it will happen).
 | 
			
		||||
 | 
			
		||||
Here are some simple equations I wrote down to illustrate the simplicity between privacy, security, tracking, fingerprinting, website functionality, UI convenience, reality, and your own expectations. I may have had one Pan Galactic Gargle Blaster too many when I wrote that, but it made perfect sense at the time.
 | 
			
		||||
Here are some equations I wrote down to illustrate the simplicity between privacy, security, tracking, fingerprinting, website functionality, UI convenience, reality, and your own expectations. I may have had one Pan Galactic Gargle Blaster too many when I wrote that, but it made perfect sense at the time.
 | 
			
		||||
 | 
			
		||||
   * 
 | 
			
		||||
 | 
			
		||||
We aim to INFORM and give you CHOICES. No one size fits all, so customize it! And not all sites have the same requirements, so use profiles with custom versions. This `user.js` is a template, and we won't set you wrong.
 | 
			
		||||
We aim to INFORM and give you CHOICES. No one size fits all, so customize it! And not all sites have the same requirements, so use [profiles](https://github.com/ghacksuserjs/ghacks-user.js/wiki/2.1-Multiple-Profiles) with custom versions. We won't set you wrong.
 | 
			
		||||
 | 
			
		||||
###  Anything else I should know?
 | 
			
		||||
Something, something, something... oh yeah... INFORMATION IS POWER.
 | 
			
		||||
@@ -20,32 +15,39 @@ Something, something, something... oh yeah... INFORMATION IS POWER.
 | 
			
		||||
We want to empower you, so you can make informed decisions to better protect yourself online. To that end, we aim to be:
 | 
			
		||||
 | 
			
		||||
* Accessible (provide information and simpler, less-technical descriptions if possible)
 | 
			
		||||
* Accountable (provide reputable references/sources, tests, dispel bad advice)
 | 
			
		||||
* Change trackable (yay! we're on github now and we also do changelogs)
 | 
			
		||||
* Accountable (provide reputable references/sources, [test sites](https://github.com/ghacksuserjs/ghacks-user.js/wiki/Appendix-C:-Test-Sites), dispel bad advice)
 | 
			
		||||
* Change trackable (yay! we're on github now, with commits)
 | 
			
		||||
* Compatible (deprecated section, [releases](https://github.com/ghacksuserjs/ghacks-user.js/releases))
 | 
			
		||||
* Comprehensive (including enforcing defaults and future-proofing)
 | 
			
		||||
* Compatible (deprecated section, releases)
 | 
			
		||||
* Current and up-to-date with stable
 | 
			
		||||
* Current and up-to-date with stable (and we also do [changelogs](https://github.com/ghacksuserjs/ghacks-user.js/search?q=label%3Achangelog&type=Issues&utf8=%E2%9C%93))
 | 
			
		||||
* Detailed (preference versioning, hidden preference information, explanations, and more)
 | 
			
		||||
* Easy to use and discuss (sections, sub-sections, numbering)
 | 
			
		||||
* Helpful (including a great comprehensive wiki, and giving good advice)
 | 
			
		||||
* Helpful (including a great comprehensive [Wiki](https://github.com/ghacksuserjs/ghacks-user.js/wiki), and giving good advice)
 | 
			
		||||
* Innovative (best format ever!, special tags, and more)
 | 
			
		||||
* Other stuff... bound to have forgotten something
 | 
			
		||||
 | 
			
		||||
###  What's in the pipeline?
 | 
			
		||||
Nothing is ever set in concrete, but we have a few ideas. These include:
 | 
			
		||||
We have a few ideas...
 | 
			
		||||
* Branches
 | 
			
		||||
   * preset versions such as "relaxed" and "hardened", for use in different profiles
 | 
			
		||||
   * an ESR version
 | 
			
		||||
* JS
 | 
			
		||||
   * providing the JS in smaller "modular" files
 | 
			
		||||
* Ramping up the wiki
 | 
			
		||||
   * Expanding heavily on the Scripts section
 | 
			
		||||
   * e10s and WebExtensions
 | 
			
		||||
   * Articles / Tutorials
 | 
			
		||||
* Ramping up the Wiki
 | 
			
		||||
   * Expanding the [Scripts](https://github.com/ghacksuserjs/ghacks-user.js/wiki#small_orange_diamond-scripts) section
 | 
			
		||||
   * e10s and WebExtensions in [Add-ons](https://github.com/ghacksuserjs/ghacks-user.js/wiki/Appendix-B:-Firefox-Add-ons)
 | 
			
		||||
   * Adding articles and tutorials
 | 
			
		||||
 | 
			
		||||
###  How do I use this?
 | 
			
		||||
Everyone, experts included, should at least read the [Implementation](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.3-Implementation) wiki page, as it contains important information relating to a few default settings we use. The rest of the [Wiki](https://github.com/ghacksuserjs/ghacks-user.js/wiki) is super helpful as well.
 | 
			
		||||
 | 
			
		||||
###  Any last words?
 | 
			
		||||
Any last words? What is this? An execution by firing squad? Man, you guys are a tough crowd! Just some background, for the record. This started as a personal, private project back in early 2015, and was released as an article by Martin Brinkmann at [ghacks](https://www.ghacks.net/) in August 2015. The response from the ghacks community was great, so along with some suggestions, I continued to keep it up-to-date and expand it (with three major updates). But six-monthly updates are problematic. So two years after I started, here we finally are at github, with all the obvious benefits that brings. I am excited about being here and looking forward to taking this to the next level with you all.
 | 
			
		||||
 | 
			
		||||
Thorin-Oakenpants, 31-Mar-2017
 | 
			
		||||
 | 
			
		||||
PS: With Martin Brinkmann's blessing, we are keeping the ghacks name.
 | 
			
		||||
 | 
			
		||||
###  Acknowledgments
 | 
			
		||||
It's impossible to acknowledge everyone - literally thousands of sources, references and suggestions. That said...
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user