From b4a4f5e6fa1b738121e2a115ef1a759a95381ee8 Mon Sep 17 00:00:00 2001 From: ItsLuiggiYahoo <56616894+ItsLuiggiYahoo@users.noreply.github.com> Date: Sun, 11 Feb 2024 00:31:25 -0300 Subject: [PATCH] Updated readme with some tutorials, better new download options and some warnings! First part of the commit, second coming tomorrow. --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 47 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bf0bf07..4da0e6b 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,58 @@ -> Public BETA Testing +> [!CAUTION] +> We're not related in any way to the official POLYTORIA team. This project is made by the community. +> [!IMPORTANT] +> This extension is in BETA, some features may be missing, and bugs found. If you found any bugs please report [Here](https://github.com/IndexingGitHub/PolyPlus/issues) + # Poly+ Poly+ is an upcoming quality-of-life browser extension for the Polytoria website! The extension provides tons of improvements to improve your experience on Polytoria! +--- + +![image](https://img.shields.io/badge/Google_chrome-4285F4?style=for-the-badge&logo=Google-chrome&logoColor=white) +![image](https://img.shields.io/badge/Opera-FF1B2D?style=for-the-badge&logo=Opera&logoColor=white) +![image](https://img.shields.io/badge/Microsoft_Edge-0078D7?style=for-the-badge&logo=Microsoft-edge&logoColor=white) +![image](https://img.shields.io/badge/Vivaldi-EF3939?style=for-the-badge&logo=Vivaldi&logoColor=white) +![image](https://img.shields.io/badge/Brave-FF1B2D?style=for-the-badge&logo=Brave&logoColor=white) +--- +# Features + +- Pinned Games +- Forum Mentions +- Theme Creator +- Store owned Tags +- Item Wishlist + And more to come! # Supported Browsers As of right now, Poly+ only works on chromium-based browsers and Firefox (however it has not been tested and is not going to be as maintained). Currently, there are no plans to bring it to other browsers in the future. > TL;DR Chromium-based browsers +### Examples +- Opera(GX, One and Normal) +- Google Chrome +- Arc +- Chromium +- Brave +- Edge -# Download Types - -## How to Download Stable? - +# How to Download? 1. First enable developer mode on your browser (developer mode allows you to load unpacked extensions) 2. Second click the "Load Unpacked" button -3. Third when the file selector comes up pick the unzipped folder from the latest release tagged in this GitHub repository on the sidebar -4. Fourth go to Polytoria and you should see some changes! +3. Third when the file selector comes up pick the unzipped folder from this GitHub repository +4. Fourth go to Polytoria and you should see the extension's button on the sidebar -## How to Download Pre-Release? +# CAUTION! Hmm, i am feeling adventurous! +## Here's how to install the Unstable Version +1. Go to the top of the page +2. Click on the "Code" button +3. Click in Download Zip +4. Extract the zip +5. Click on extensions -> Manage Extensions +6. Click on Developer Mode +7. Load without compressing +8. Find the folder you extracted +9. And now you have it! -> Pre-Release builds may have work in progress features or bugs! - -To download the stable build, simply follow the instructions above. However, to access the pre-release build, download the source code of the GitHub itself and follow the same steps as outlined in the stable build download instructions. +# How to update it? +1. Uninstall the extension +2. Delete the old folder and .zip file +3. Download the new version +4. Follow the step 3 and 4 from How to Download's tab.