diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc01397 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +
+ + + +# YouTube Customizer + +Web browser extension for customizing YouTube + +
+ +
+ + + + +
+ + +![Demo screenshot](img/demo.png) + +## Features +- Toggling various elements of layout (e.g sidebar buttons) +- Redirecting home page to subscriptions +- [ff2mpv](https://github.com/woodruffw/ff2mpv) integration + +## Usage +Get the addon + +*Chromium-based browsers are not supported* + +## Configuration +The extension provides configuration using settings page that can be accessed through web browser extension page. + +![Settings Page](img/settings_page.png) + +## Supported languages +The extension has localization for the following languages: +- English +- Spanish +- French +- Hungarian +- Russian + +## Building +YouTube Customizer uses [pnpm](https://github.com/pnpm/pnpm) and [web-ext](https://github.com/mozilla/web-ext) for building and bundling final package, as well as [TypeScript transpiler](https://github.com/microsoft/TypeScript) for building JavaScript sources. + +1. Install TypeScript, pnpm and web-ext using system package manager or npm +``` +npm install -g typescript web-ext pnpm +``` + +2. Install dependencies and run build +``` +pnpm install +pnpm build +``` + +# Contributing +All issues and pull requests are welcome! Feel free to open an issue if you've got an idea or a problem. You can open a pull request if you are able to implement it yourself. + +--- +

+ + Made with ponies and love! +
+ GNU GPL © Ryze 2023 💜 +
+

diff --git a/img/amo_button.png b/img/amo_button.png new file mode 100644 index 0000000..f640023 Binary files /dev/null and b/img/amo_button.png differ diff --git a/img/demo.png b/img/demo.png new file mode 100644 index 0000000..48b070b Binary files /dev/null and b/img/demo.png differ diff --git a/img/settings_page.png b/img/settings_page.png new file mode 100644 index 0000000..651a3d3 Binary files /dev/null and b/img/settings_page.png differ