summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md87
1 files changed, 43 insertions, 44 deletions
diff --git a/README.md b/README.md
index bd4f71d..e087991 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,37 @@
-### 🟪 What is unifox.js ?
-Unifox.js is autobootstrap-script that configures a keyboard based, unified and distraction-free Firefox-UI plus Webpagedesign with the help of the `toolkit.legacyUserProfileCustomizations.stylesheets` function, as well as security and anti-tracking features with the help of [arkenfox](https://github.com/arkenfox/user.js/).
+### 🟪 What is fox.js ?
+Fox.js is an autobootstrap-script that configures a keyboard based and distraction-free Firefox-UI plus Webpagedesign with the help of the `toolkit.legacyUserProfileCustomizations.stylesheets` function.
![2024-08-09-045130_1920x1080_scrot](https://github.com/user-attachments/assets/8d693063-5032-4c87-9d56-3c2335ff158b)
-### 🟨 The Autobootstrap Script will do the following with your boring firefox:
+### 🟨 The sharks.sh script:
-1. Creates a new profile called `unifox`, which in itself creates a new directory in your `.mozilla` configuration folder
+1. Creates a new profile called `fox`, which in itself creates a new directory in your `.mozilla` configuration folder
-2. Inside your new profile directory, it will install the addon's:
-- [ublock-origin](https://ublockorigin.com/) [preconfigured]
-- [stlyus](https://github.com/openstyles/stylus) [preconfigured]
-- [vimimium-c](https://github.com/gdh1995/vimium-c) [preconfigured]
-
-3. Then configures the labelled Add-On's, with the files from the `extensions` folder.
+2. Drops the user.js in your new created profile which itself activate's `toolkit.legacyUserProfileCustomizations.stylesheets` wich is needed for the files in step 3 to take effect
+3. Drops the .css configurations within the folder `chrome`
-4. Activate'S `toolkit.legacyUserProfileCustomizations.stylesheets` which is necessary for the Files within the folder `chrome` to take effect. Then copie's the .css configuration files into which include:
- userChrome.css
- userContent.css
- userChrome.js
-5. Set a custom about:home which can be changed within the `.mozilla/firefox/xxxxx.default-release/chrome/img/` directory.
+4. Sets a custom about:home which can be changed within the `.mozilla/firefox/xxxxx.fox/chrome/userContent.css` file.
+
+5. Drops `extension-settings.json` to set the bindings for the add on's
+
+**Manually (optional):**
+
+5. At last sync your profile for personal bookmarks & passwords and cookies
-6. At last copies my `user.js` and extension-settings.json.
-
### 🟩 Installaion:
```
-git clone https://github.com/marlonivo/unifox.git && cd unifox && chmod +x unifox.sh && ./unifox
+git clone https://github.com/marlonivo/unifox.git && chmod +x unifox.sh && cd unifox && ./unifox
```
+There will be no update option for this repository, after the installation your firefox-sharks-browser is truly yours.
+
### 🟦 Unified Keybindings for page-navigation and browser-tab-operations:
-**page navigation:**<br>
+*page navigation:*<br>
`?` - show help (overview of all keybindings)<br>
`f` - show quick keybinding's<br>
`j` - scroll down<br>
@@ -39,37 +40,35 @@ git clone https://github.com/marlonivo/unifox.git && cd unifox && chmod +x unifo
&nbsp;&nbsp;&nbsp;&nbsp;`n` - cycle through 'find mode'<br>
`r` - reload tab<br>
`x` - close tab<br>
-**will come in future:**<br>
+
+*website manipulation:*
`t` - translate webpage<br>
`d` - de-/activate dark mode<br>
`s` - screenshot
+`<c a i>` - zoom in-to video<br>
+`<c a o>` - zoom out-of video
-**browser tab operations:**<br>
-`strg tab` - cycle through open Tabs<br>
-`strg t` - new tab<br>
-&nbsp;&nbsp;&nbsp;&nbsp;`strg alt y` - https://youtube.com<br>
-&nbsp;&nbsp;&nbsp;&nbsp;`strg alt h` - vimium://options<br>
-&nbsp;&nbsp;&nbsp;&nbsp;`strg alt e` - https://deepl.com<br>
-&nbsp;&nbsp;&nbsp;&nbsp;`strg alt g` - https://github.com<br>
-&nbsp;&nbsp;&nbsp;&nbsp;`strg alt k` - https://chatgpt.com<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<br>
-`strg shift a` - about:addons<br>
-
-**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
-
+*browser tab operations:*<br>
+`<c tab>` - cycle through open Tabs<br>
+`<c t>` - new tab<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`<c a y>` - https://youtube.com<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`<c a v>` - vimium://options<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`<c a e>` - https://deepl.com<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`<c a g>` - https://github.com<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`<c a t>` - https://chatgpt.com<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`<c a s>` - stylus dropdown<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`<c a u>` - ublock origin dropdown<br>
+&nbsp;&nbsp;&nbsp;&nbsp;`<c a p>` - ublock element picker<br>
+` <c left>` - go one step back in history<br>
+`<a right>` - go one step forth in history<br>
+`<c s s>` - make a screenshot<br>
+`<c s h>` - search history, downloads, tags and bookmarks<br>
+`<c s k>` - developer console<br>
+`<c s a>` - about:addons<br>
+*youtube:*<br>
+`t` - cinema mode<br>
+`f` - fullscreen<br>
+`s` - subtitles<br>
+🟦 License: MIT