Updated readme with some tutorials, better new download options and some warnings!
First part of the commit, second coming tomorrow.
This commit is contained in:
parent
5f601f8c07
commit
b4a4f5e6fa
1 changed files with 47 additions and 11 deletions
58
README.md
58
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+
|
||||||
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!
|
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!
|
||||||
|
---
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
---
|
||||||
|
# Features
|
||||||
|
|
||||||
|
- Pinned Games
|
||||||
|
- Forum Mentions
|
||||||
|
- Theme Creator
|
||||||
|
- Store owned Tags
|
||||||
|
- Item Wishlist
|
||||||
|
And more to come!
|
||||||
|
|
||||||
# Supported Browsers
|
# 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.
|
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
|
> TL;DR Chromium-based browsers
|
||||||
|
### Examples
|
||||||
|
- Opera(GX, One and Normal)
|
||||||
|
- Google Chrome
|
||||||
|
- Arc
|
||||||
|
- Chromium
|
||||||
|
- Brave
|
||||||
|
- Edge
|
||||||
|
|
||||||
# Download Types
|
# How to Download?
|
||||||
|
|
||||||
## How to Download Stable?
|
|
||||||
|
|
||||||
1. First enable developer mode on your browser (developer mode allows you to load unpacked extensions)
|
1. First enable developer mode on your browser (developer mode allows you to load unpacked extensions)
|
||||||
2. Second click the "Load Unpacked" button
|
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
|
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 some changes!
|
4. Fourth go to Polytoria and you should see the extension's button on the sidebar
|
||||||
|
|
||||||
## How to Download Pre-Release?
|
# <span style="color:red">CAUTION!</span> 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!
|
# How to update it?
|
||||||
|
1. Uninstall the extension
|
||||||
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.
|
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.
|
||||||
|
|
|
||||||
Reference in a new issue