README.md

@@ -0,0 +1,17 @@
+### :large_blue_diamond: user.js
+A `user.js` is a configuration file that can control hundreds of Thunderbird settings. For a more technical breakdown and explanation, you can read more on the [overview](https://github.com/dngray/ghacks-thunderbird-user.js/wiki/1.1-Overview) wiki page.
+
+### :large_blue_diamond: thunderbird user.js
+The Thunderbird `user.js` is a **template** which aims to provide as much privacy and enhanced security as possible. It differs from the `ghacks user.js` in that the focus is to keep Thunderbird as an **email client** and disable as many web browsing features as possible. We believe web browsing should be done in a web browser, and not an email client.
+
+- If you're using Thunderbird with Tor we suggest that you install the [TorBirdy](https://addons.thunderbird.net/addon/torbirdy) addon. If you are using Tor, you should also consider using [Tails](https://tails.boum.org/) or [Whonix](https://www.whonix.org/).
+- If you're a **Gmail** user see [this article about OAuth2](https://github.com/dngray/ghacks-thunderbird-user.js/wiki/3.1-OAuth2-Users).
+- For information about [extensions](https://github.com/dngray/ghacks-thunderbird-user.js/wiki/4.1-Extensions), see the wiki. **Calendar** users should [see this page](https://github.com/dngray/ghacks-thunderbird-user.js/wiki/4.1.1-Calendar).
+
+Also be aware that this `user.js` is made specifically for Thunderbird and has only been tested in the latest stable release.
+
+### :large_blue_diamond: acknowledgments
+* [tya99](https://github.com/tya99) most of the ground work and initial port from the Firefox version of [ghacks user.js](https://github.com/ghacksuserjs/ghacks-user.js)
+* [dngray](https://github.com/dngray) continual maintenance and Wiki
+
+### :large_blue_diamond: [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)