summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md72
1 files changed, 66 insertions, 6 deletions
diff --git a/README.md b/README.md
index 41a15c2..d8f107d 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,74 @@
-🟪 unifox.js
+### 🟪 What is unifox.js ?
+Unifox.js is autobootstrap-script that configures a unified-and distraction-free Browser-UI & Webpagedesign, as well as security and anti-tracking features from with the help of [arkenfox](https://github.com/arkenfox/user.js/) and addon's like [decentraleyes](https://decentraleyes.org/).
-A user.js is a configuration file that can overrides the Firefox settings to provide as much minimalism and enhanced security as possible.
+### 🟨 The Autobootstrap Script will do the following with your boring firefox:
-Everyone, experts included, should at least read the wiki, as it contains important information regarding a few unifox.js settings.
+1. Inside your .mozilla directory, it will install the addon's:
+- [ublock-origin](https://ublockorigin.com/) [preconfigured]
+- [decentraleyes](https://decentraleyes.org/)
+- [istilldontcareaboutcookies](https://www.stilldontcareaboutcookies.com/)
+- [vimimium-c](https://github.com/gdh1995/vimium-c) [preconfigured]
+
+2. Then configures the labelled Add-On's, with the included `addons.json` file.
-🟩 Installaion
+3. Create a folder in the called `chrome` with a wide variety of simplicty making .css configuration files which include:
+- userChrome.css
+- userContent.css
+- userChrome.js
-`bash <(curl -s https://raw.githubusercontent.com/marlonivo/unifox.js/main/install.sh)`
+4. Set a custom background which can be changed within the `.mozilla/firefox/xxxxx.default-release/chrome/img/` directory.
-🟪 License: MIT
+5. At last copies my `prefs.js` to activate `toolkit.legacyUserProfileCustomizations.stylesheets` which is necessary for the Files within the folder `chrome` to take effect and also because some extensions store their settings in there.
+
+### 🟩 Installaion:
+```
+git clone https://raw.githubusercontent.com/marlonivo/unifox.js
+cd unifox.js
+install.sh
+```
+
+### 🟦 Unified Keybindings for page-navigation and browser-tab-operations:
+
+**page navigation:**<br>
+`?` - show help (overview of all keybindings)<br>
+`f` - show quick keybinding's<br>
+`j` - scroll down<br>
+`k` - scroll up<br>
+`/` - enter find mode<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`n` - cycle through 'find mode'<br>
+`r` - reload tab<br>
+`x` - close tab<br>
+**will come in future:**<br>
+`t` - translate webpage<br>
+`d` - de-/activate dark mode<br>
+`s` - screenshot
+
+**browser tab operations:**<br>
+`strg tab` - cycle through open Tabs<br>
+`strg t` - new tab<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg y` - https://youtube.com<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg h` - vimium://options<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg e` - https://deepl.com<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg g` - https://github.com<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg k` - https://chatgpt.com<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg alt a` - about:addons<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg alt c` - stylus toolbar<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg alt u` - ublock origin toolbar<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`strg alt p` - ublock element picker<br>
+`alt left` - go one step back in history<br>
+`alt right` - go one step forth in history<br>
+`strg shift s` - make a screenshot<br>
+`strg shift h` - search history, downloads, tags and bookmarks<br>
+`strg shift k` - developer console
+
+**youtube:**<br>
+`t` - cinema mode<br>
+`s` - fullscreen<br>
+`c` - subtitles<br>
+`strg alt i` - zoom in-to video<br>
+`strg alt o` - zoom out-of video
+
+### 🟦 License: MIT