Initial push with version 0.1.1

1 files changed, 65 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f26f32f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# Transparent Zen

+

+Transparent Zen is a browser extension specifically designed for Zen Browser. This extension injects styles into supported websites to make them transparent, providing a new experience.

+

+## Supported Websites

+🔴 = Not working / Broken

+<br>

+🟠 = Work in Progress

+<br>

+🟢 = Working

+

+The following websites are currently supported by Transparent Zen:

+

+- 🟠 amazon.de

+- 🟠 bing.com

+- 🟢 ddl-warez.cc

+- 🔴 epicgames.com

+- 🔴 github.com

+- 🔴 gog.com

+- 🔴 kinguin.net

+- 🟠 kryptex.com

+- 🟠 lieferando.at

+- 🟢 mail.proton.me

+- 🟠 nexusmods.com

+- 🟢 reddit.com

+- 🟢 store.steamworks.com

+- 🟢 steamcommunity.com

+- 🟢 wuwatracker.com

+- 🟢 youtube.com

+

+## Prerequisites

+#### Windows 11

+1. Install [MicaForEveryone](https://github.com/MicaForEveryone/MicaForEveryone)

+2. In MicaForEveryone add a new process rule and select "zen"

+3. Activate **Blur Behind** and set the Backdrop Type to **Acrylic**

+4. Open Zen Browser and go to `about:config`

+5. Make sure that `browser.tabs.allow_transparent_browser` is set to **true**

+6. Also make sure that `browser.tabs.allow_transparent_browser` is set to **true**

+

+##### TODO: Add other OS prerequisites

+

+## Installation

+

+To install Transparent Zen, you can either download it from the [Firefox Add-Ons Store](https://addons.mozilla.org/de/firefox/addon/transparent-zen) or grab the latest release from github and manually install it through the Zen Browser settings.

+

+## Usage

+

+Once installed, Transparent Zen will automatically apply transparent styles to the supported websites listed above. No further configuration is required.

+

+## Contributing

+

+The main idea behind this project is for the community to contribute and add styles for their favorite websites, so that everyone can enjoy a fully transparent experience.

+<br>

+If you would like to contribute to Transparent Zen, please follow these steps:

+

+1. Fork the repository.

+2. Create a new branch for your feature or bug fix.

+3. Make your changes and commit them with a descriptive message.

+4. Push your changes to your fork and create a pull request.

+

+## License

+

+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.

+

+Enjoy your transparent browsing experience with Transparent Zen!
\ No newline at end of file