Merge pull request #4 from ItsLuiggiYahoo/patch-1
Updated readme with some tutorials, better new download options and s…
This commit is contained in:
Index
GitHub
commit
489309814b
1 changed files with 63 additions and 11 deletions
74
README.md
74
README.md
|
|
@ -1,22 +1,74 @@
|
||||||
> Public BETA Testing
|
> [!CAUTION]
|
||||||
|
> Poly+ is in no way affiliated with the Polytoria team. This is a project I started for the community - and I hope some community members are willing to help with development so the extension is better for everyone ❤️.
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> This extension is currently in BETA. If you find any bugs, please report them in this repository's issues section as it'd be a great help towards development of the extension.
|
||||||
|
|
||||||
# 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! Visit the website [here](https://polyplus.vercel.app/)!
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
^ shields.io for the badges ❤️
|
||||||
|
|
||||||
|
# Features
|
||||||
|
|
||||||
|
- Pinned Games
|
||||||
|
- Forum Mentions
|
||||||
|
- Best Friends
|
||||||
|
- Improved Friend Lists
|
||||||
|
- IRL Price with Brick Count
|
||||||
|
- Hide Sidebar Notification Badges
|
||||||
|
- Theme Creator
|
||||||
|
- Store `owned` Tags
|
||||||
|
- More Search Filters
|
||||||
|
- Modify Navbar
|
||||||
|
- Free Membership Themes
|
||||||
|
- Multi-Cancel Outbound Trades
|
||||||
|
- Item Wishlist
|
||||||
|
- Outfit Cost
|
||||||
|
And there is 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. Currently, there are no plans to bring it to other browsers in the future.
|
||||||
> TL;DR Chromium-based browsers
|
> TL;DR Chromium-based browsers
|
||||||
|
|
||||||
# Download Types
|
## Examples of Browsers that are Chromium-based
|
||||||
|
- Google Chrome
|
||||||
|
- Chromium
|
||||||
|
- Edge
|
||||||
|
- Opera (& it's variations)
|
||||||
|
- Brave
|
||||||
|
- Arc
|
||||||
|
|
||||||
## How to Download Stable?
|
# Downloading
|
||||||
|
|
||||||
1. First enable developer mode on your browser (developer mode allows you to load unpacked extensions)
|
## How to Download - Stable Build?
|
||||||
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!
|
|
||||||
|
|
||||||
## How to Download Pre-Release?
|
1. Go to the releases section of this GitHub repository
|
||||||
|
3. Go to the latest release and download the .ZIP file for that release
|
||||||
|
4. Extract the .ZIP
|
||||||
|
5. Enable developer mode on your browser (developer mode allows you to load unpacked extensions)
|
||||||
|
6. Click the "Load Unpacked" button
|
||||||
|
7. When the file selector comes up, open the unzipped folder from this GitHub repository
|
||||||
|
8. Go to Polytoria and you should see some changes!
|
||||||
|
|
||||||
|
## How to Download - Pre-Release Build?
|
||||||
|
|
||||||
> Pre-Release builds may have work in progress features or bugs!
|
> 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.
|
1. Go to the top of this GitHub repository
|
||||||
|
2. Click on the "Code" button
|
||||||
|
3. Click on the "Download ZIP" button in the dropdown menu
|
||||||
|
4. Extract the .ZIP
|
||||||
|
5. Enable developer mode on your browser (developer mode allows you to load unpacked extensions)
|
||||||
|
6. Go to your browsers extensions page (usually `browserName://extensions`)
|
||||||
|
8. Click the "Load Unpacked" button
|
||||||
|
9. When the file selector comes up, open the unzipped folder of this repository's source code
|
||||||
|
10. Go to Polytoria and you should see some changes!
|
||||||
|
|
|
||||||
Reference in a new issue