docs: privacy section & small refactor

README-summary.md

@@ -7,7 +7,7 @@
 <h4>Available in these languages: <abbr title="Chinese (Simplified, China)">🇨🇳&nbsp;CN</abbr>, <abbr title="English (Great Britain)">🇬🇧&nbsp;GB</abbr>, <abbr title="English (United States)">🇺🇸&nbsp;US</abbr>, <abbr title="French (France)">🇫🇷&nbsp;FR</abbr>, <abbr title="German (Germany)">🇩🇪&nbsp;DE</abbr>, <abbr title="Hindi (India)">🇮🇳&nbsp;IN</abbr>, <abbr title="Japanese (Japan)">🇯🇵&nbsp;JP</abbr>, <abbr title="Portuguese (Brazil)">🇧🇷&nbsp;BR</abbr>, <abbr title="Spanish (Spain)">🇪🇸&nbsp;ES</abbr></h4>
 
 ---
-#### [**Features**](#features) • [**Installation**](#installation) • [**Integrations**](#integrations) • [**Plugins**](#plugins) • [**Support**](#support) • [**Development**](#development) • [**Attributions**](#attributions) • [**Disclaimers**](#disclaimers)
+#### [**Features**](#features) • [**Installation**](#installation) • [**Integrations**](#integrations) • [**Plugins**](#plugins) • [**Support**](#support) • [**Privacy**](#privacy) • [**Development**](#development) • [**Attributions**](#attributions) • [**Disclaimers**](#disclaimers)
 <!-- END OF GENERATED CONTENT -->
 <!-- </{{HEADER}}> -->
 
@@ -44,7 +44,7 @@ My work relies on donations, so if you like this userscript please consider [sup
 <br><br>
 
 ## Installation:
-
+Note: by installing BetterYTM, you agree to the [license terms](./LICENSE.txt), [disclaimers](#disclaimers) and [privacy notice.](#privacy)
 1. **Install a userscript manager browser extension - I really recommend Violentmonkey ([Firefox](https://addons.mozilla.org/en-US/firefox/addon/violentmonkey/), [Chrome](https://chrome.google.com/webstore/detail/violentmonkey/jinjaccalgkegednnccohejagnlnfdag), [Edge](https://microsoftedge.microsoft.com/addons/detail/violentmonkey/eeagobfjdenkkddmbclomhiblgggliao?hl=en-GB&gl=DE)).**  
   <sub>Other extensions are known to not work as expected, especially in isolated contexts like with FireMonkey or the Brave browser (<a href="https://github.com/Sv443/BetterYTM/issues/115#issuecomment-2468374348" target="_blank">more info here</a>).</sub>
 
@@ -92,7 +92,22 @@ Currently there are no available plugins, but you can [submit an issue using the
 If you have any questions, issues, or feature requests, please [open an issue here.](https://github.com/Sv443/BetterYTM/issues/new/choose)  
 You can also join my Discord server and ask your questions there or just hang out with other community members and me:  
   
-[![Discord](https://img.shields.io/discord/565933531214118942)](https://discord.gg/aBH4uRG)
+[![Discord](https://img.shields.io/discord/565933531214118942)](https://dc.sv443.net/)
+
+<br><br>
+
+## Privacy:
+BetterYTM does not collect any data about you that isn't strictly necessary for its features to work.  
+All data is recorded and stored on your device or on the servers of the site the script runs on.  
+  
+BetterYTM makes use of external services and APIs to provide some of its features, which may collect data about you.  
+In every case, only the bare minimum of data is sent to these services and only when necessary.  
+This data includes your IP address and the ID or title and author of the video you're watching.  
+  
+Find more info about the privacy of these services here:
+- [Return YouTube Dislike - Security FAQ](https://github.com/Anarios/return-youtube-dislike/blob/main/Docs/SECURITY-FAQ.md)
+- [SponsorBlock - Privacy Policy](https://gist.github.com/ajayyy/aa9f8ded2b573d4f73a3ffa0ef74f796#requests-sent-to-the-server-while-using-the-extension)
+- [geniURL - Privacy Policy](https://sv443.net/privacypolicy/en)
 
 <br><br>
 

README.md

@@ -8,7 +8,7 @@
 <h4>Available in these languages: <abbr title="Chinese (Simplified, China)">🇨🇳&nbsp;CN</abbr>, <abbr title="English (Great Britain)">🇬🇧&nbsp;GB</abbr>, <abbr title="English (United States)">🇺🇸&nbsp;US</abbr>, <abbr title="French (France)">🇫🇷&nbsp;FR</abbr>, <abbr title="German (Germany)">🇩🇪&nbsp;DE</abbr>, <abbr title="Hindi (India)">🇮🇳&nbsp;IN</abbr>, <abbr title="Japanese (Japan)">🇯🇵&nbsp;JP</abbr>, <abbr title="Portuguese (Brazil)">🇧🇷&nbsp;BR</abbr>, <abbr title="Spanish (Spain)">🇪🇸&nbsp;ES</abbr></h4>
 
 ---
-#### [**Features**](#features) • [**Installation**](#installation) • [**Integrations**](#integrations) • [**Plugins**](#plugins) • [**Support**](#support) • [**Development**](#development) • [**Attributions**](#attributions) • [**Disclaimers**](#disclaimers)
+#### [**Features**](#features) • [**Installation**](#installation) • [**Integrations**](#integrations) • [**Plugins**](#plugins) • [**Support**](#support) • [**Privacy**](#privacy) • [**Development**](#development) • [**Attributions**](#attributions) • [**Disclaimers**](#disclaimers)
 <!-- END OF GENERATED CONTENT -->
 <!-- </{{HEADER}}> -->
 
@@ -47,7 +47,7 @@ If you disabled the watermark, you can still open it by clicking your avatar in
 <br><br><br>
 
 ## Installation:
-
+Note: by installing BetterYTM, you agree to the [license terms](./LICENSE.txt), [disclaimers](#disclaimers) and [privacy notice.](#privacy)
 1. **Install a userscript manager browser extension - I really recommend Violentmonkey ([Firefox](https://addons.mozilla.org/en-US/firefox/addon/violentmonkey/), [Chrome](https://chrome.google.com/webstore/detail/violentmonkey/jinjaccalgkegednnccohejagnlnfdag), [Edge](https://microsoftedge.microsoft.com/addons/detail/violentmonkey/eeagobfjdenkkddmbclomhiblgggliao?hl=en-GB&gl=DE)).**  
   <sub>Other extensions are known to not work as expected, especially in isolated contexts like with FireMonkey or the Brave browser (<a href="https://github.com/Sv443/BetterYTM/issues/115#issuecomment-2468374348" target="_blank">more info here</a>).</sub>
 
@@ -99,6 +99,21 @@ You can also join my Discord server and ask your questions there or just hang ou
 
 <br><br>
 
+## Privacy:
+BetterYTM does not collect any data about you that isn't strictly necessary for its features to work.  
+All data is recorded and stored on your device or on the servers of the site the script runs on.  
+  
+BetterYTM makes use of external services and APIs to provide some of its features, which may collect data about you.  
+In every case, only the bare minimum of data is sent to these services and only when necessary.  
+This data includes your IP address and the ID or title and author of the video you're watching.  
+  
+Find more info about the privacy of these services here:
+- [Return YouTube Dislike - Security FAQ](https://github.com/Anarios/return-youtube-dislike/blob/main/Docs/SECURITY-FAQ.md)
+- [SponsorBlock - Privacy Policy](https://gist.github.com/ajayyy/aa9f8ded2b573d4f73a3ffa0ef74f796#requests-sent-to-the-server-while-using-the-extension)
+- [geniURL - Privacy Policy](https://sv443.net/privacypolicy/en)
+
+<br><br>
+
 ### Development:
 This project is based on my extensive template for making a userscript with TypeScript and many modern language and convenience features.  
 [Check it out here](https://github.com/Sv443/Userscript.ts) if you want to make your own userscripts!  
@@ -119,9 +134,9 @@ This userscript depends on these projects:
   
 For development dependencies, please refer to `devDependencies` in [`package.json`](./package.json)
   
-Icons:  
+#### Icon attributions:  
 - Most icons are from [Material Icons](https://fonts.google.com/icons)
-- For external icon attributions, see [`assets/images/external/`](assets/images/external/README.md)
+- For external icon attributions, see [`assets/images/external/README.md`](assets/images/external/README.md)
 
 <br><br>
 

assets/README.md

@@ -29,6 +29,7 @@ The keys of the object are the locale codes, and the values are the locale objec
 | `emoji`          | `string`   | The flag emoji of the locale                               |
 | `userscriptDesc` | `string`   | The description of the userscript in the locale's language |
 | `authors`        | `string[]` | The authors of the translations                            |
+| `altLocales`     | `string[]` | Alternative locales that are similar to this one           |
 
 <br>
 
@@ -61,16 +62,16 @@ The configuration object can have the following properties:
 
 ### [`require.json`](require.json)
 This file contains the npm libraries that are loaded into the runtime through the `@require` userscript directive.  
-This is done to massively reduce the bundle size and make use of the userscript extension's caching.  
-Each library will be set as an external in the [Rollup configuration](../rollup.config.js) to prevent it from including it in the bundle.  
-The version of each package will be inferred from [`package.json`](../package.json) to ensure consistent versions across the project.  
+This is done to massively reduce the bundle size and make use of the userscript manager extension's caching.  
+Each library will be set as an external in the [rollup configuration](../rollup.config.js) to prevent it from including it in the bundle.  
+The version of each package will be parsed from [`package.json`](../package.json)'s `dependencies` or `devDependencies` to ensure consistent versions across the project.  
   
 Inside the file is an array of objects, which each have one of the following properties:  
   
 Using npm packages through a CDN:
 | Property   | Type      | Description                                                                         |
 | :--------- | :-------- | :---------------------------------------------------------------------------------- |
-| `pkgName`  | `string`  | The name of the npm package, as in `npm i <pkgName>`                                |
+| `pkgName`  | `string`  | The name of the npm package, as in `npm i pkgName`                                |
 | `path`     | `string`  | The path to the file that should be loaded, relative to the library root dir        |
 | `global`   | `string`  | The name of the global variable that the library exports                            |
 | `baseUrl?` | `string`  | Base URL of the CDN to use - `https://cdn.jsdelivr.net/npm/` by default - package will be appended as `pkgName@versionFromPkgJson` |

contributing.md

@@ -1,9 +1,11 @@
 # BetterYTM - Contributing Guide
 Thank you for your interest in contributing to BetterYTM!  
 This guide will help you get started with contributing to the project.  
+  
 It contains boatloads of information on internal workings, how to set up the project for local development, how to submit translations and how to develop a plugin that interfaces with BetterYTM.  
+Also, each folder of the project should contain a `README.md` file that further explains the contents of the folder and how to work with them in much more detail.  
   
-If you have any questions or need help, feel free to contact me, [see my homepage](https://sv443.net/) for contact info.  
+If you have any questions or need help, feel free to contact me ([visit my homepage](https://sv443.net/) for contact info).  
 Or you can also [join my Discord server](https://dc.sv443.net) to get in touch or get help.  
 
 <br>

src/tools/gen-readme.ts

@@ -102,7 +102,7 @@ async function genHeader() {
 <h4>Available in these languages: ${langStr}</h4>
 
 ---
-#### [**Features**](#features) • [**Installation**](#installation) • [**Integrations**](#integrations) • [**Plugins**](#plugins) • [**Support**](#support) • [**Development**](#development) • [**Attributions**](#attributions) • [**Disclaimers**](#disclaimers)\
+#### [**Features**](#features) • [**Installation**](#installation) • [**Integrations**](#integrations) • [**Plugins**](#plugins) • [**Support**](#support) • [**Privacy**](#privacy) • [**Development**](#development) • [**Attributions**](#attributions) • [**Disclaimers**](#disclaimers)\
 `;
 }