Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refined README.md. Revised and added helpful features #17

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refined README.md. Revised and added helpful features #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 38 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# Grailed Plus // Grailed+
Browser Extension for checking an item's price history on grailed.com.

## How It Works

Grailed+ monitors item listings on Grailed by accessing their publicly available metadata. The extension collects pricing data to generate the price history and predict future item listing drops. The metadata feature lets users download a file that contains all details about the listing.

## Current Features
* Price history
* Average price drop
* Next expected drop
* Seller account creation date
* Full listing meta-data file
* and more...
- **Price History**: See how the price of an item has changed over time.
- **Average Price Drop**: Get the average percentage drop for each drop on the item you are currently viewing.
- **Next Expected Drop**: Predict when the next price drop may happen based on previous trends.
- **Seller Account Creation Date**: View when the seller’s account was created, giving you more context on their reputability.
- **Full Listing Meta-Data File**: Download a full metadata file of any listing.
- **And more...**


#### Feature Screenshots:
| Price History & Drop Average | Listing Meta-Data button (towards bottom of page) |
Expand All @@ -21,3 +26,30 @@ Stable Release Available on the [Firefox Addons Store](https://addons.mozilla.or
Stable Release Available on the [Chrome Web Store](https://chrome.google.com/webstore/detail/grailed-plus/ipecfmmbppgpommpibaandmonmhohfnd). For Chromium see Other.
#### Other / Latest (pre)Release
It can take a bit to get latest releases approved on some webstores (looking at you Google), so the latest patches and releases can be installed manually. Download and extract the [latest release](https://github.com/RVRX/grailed-plus/releases/latest)'s `grailed_plus-X.X.X.zip`, and follow your browser's extension installation documentation from there.


## Steps to Contribute:

1. Fork the repo and clone it locally.
2. Make sure you have [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
3. Run `npm install` to install all dependencies.
4. Make your changes and run `npm run build` to build the extension.
Comment on lines +35 to +36
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't an NPM project ;)
Just JS + a little JQuery.

5. Submit a pull request with a detailed description of the changes.


## FAQ

**Q: How accurate is the price drop prediction feature?**
A: The price drop prediction feature is based on previous price drops for the same item, so while it is generally reliable, it may not always be correct.

**Q: How frequently is the price data updated?**
A: Data is updated in real time as the extension scrapes the price change history on the given listing.

**Q: What permissions does the extension need and why?**
A: Grailed+ needs permission to access Grailed's listing pages to scrape the price and metadata. It does not collect or store user information.



## License

This project is licensed under the [MIT](LICENSE) License