Replace the readme

This commit is contained in:
buzz-lightsnack-2007 2025-01-04 16:36:33 +08:00
parent ebbbbd0b02
commit 1820b4d2ca
2 changed files with 34 additions and 32 deletions

View file

@ -1,32 +0,0 @@
# ShopAI
**_Shop wisely with AI!_**
[▶︎ Shop wisely now.](https://codeberg.org/buzzcode2007/ShopAI-Extension/releases)
## Background
The onset of the pandemic gave rise to the popularity of online shopping. In a survey cited by Balinbin (2021) focusing on changes in consumer behavior, around 90% of Filipinos would find online shopping convenient and price-friendly. Other factors mentioned in the study included the success of online live selling and the ability to communicate with sellers through these platforms. Since most teenagers and working adults have access to mobile devices and internet, many e-commerce platforms primarily cater to this demographic through their tie-ins with social media or at least its trends.
Unfrotunately, it seems that the purchasing-centered interface has led to dominance of fake or misleading products within these platforms. These products use clickbait titles paired with vague or non-English descriptions, resulting in an information asymmetry and preventing some customers from purchasing correctly. Worse, they are also often placed between legitimate and properly-labeled products, increasing the difficulty and possibly wasting customers time. This does not only apply to knockoff or "山寨" products but also on other low-quality products in general.
What if we could enhance the current system through a web extension that seamlessly integrates with the shopping websites? Introducing ShopAI, a severless solution where artificial intelligence meets online shopping platforms!
## Features
- [X] Get the data of a selected product from the e-commerce page through filters.
- [X] Generate information of the product through Google Geminis API.
- [X] Display the generated information within the e-commerce page.
- [X] Download and update filters automatically and manually.
- [X] Synchronize extension preferences across the browser synchronization instance.
- [X] Store the product information and the analysis.
- [X] Provide help features to instruct users on extension usage.
## Installation
The extension is available via this repository's releases, and it is compatible wherever you find an extensions market. We hope to make this available on the Chrome Web Store or the Microsoft Add-Ons Store.
You may click the link directly if you're on Firefox or Waterfox; otherwise, you'll have to right click and save the file from the menu. In that case, you'll first need to enable developer mode for extensions to install this extension.
1. Go to [`about:extensions`](about:extensions) on your Chromium-based web browser.
2. Toggle the developer options.
3. Drag and drop the extension to the window.
4. Accept the permissions to install.
## Contributions
Tripped on a bug, or did a lightbulb lit? Feel free to let us know! If there are not yet opened bug reports, please [create one](https://codeberg.org/buzzcode2007/ShopAI-Extension/issues/new)!

34
README.txt Normal file
View file

@ -0,0 +1,34 @@
Program title: ShopAI
Program author: Hansly Saw
Version: 1
Date: 2025.01.04
FEATURES
- [X] Get the data of a selected product from the e-commerce page through filters.
- [X] Generate information of the product through Google Geminis API.
- [X] Display the generated information within the e-commerce page.
- [X] Download and update filters automatically and manually.
- [X] Synchronize extension preferences across the browser synchronization instance.
- [X] Store the product information and the analysis.
- [X] Provide help features to instruct users on extension usage.
INSTALLATION
The extension is available via this repository's releases, and it is compatible wherever you find an extensions market.
To install, you'll have to right click and save the file from the menu. In that case, you'll first need to enable developer mode for extensions to install this extension.
1. Go to [`about:extensions`](about:extensions) on your Chromium-based web browser.
2. Toggle the developer options.
3. Drag and drop the extension to the window.
4. Accept the permissions to install.
HOW TO USE
1. Open any e-commerce platform of your choice (Lazada, Shopee, etc.)
2. Select a product.
3. Look for ShopAIs icon in your browser toolbar (usually located at the upper right corner of the web browsers window) and click on it.
4. Click on the details to expand the pop-up and view more information about the product.
DISCLAIMER
This extension is guaranteed to work in web browsers in desktop mode. It's not recommended for mobile use, although we will also launch a mobile version.
CONTRIBUTIONS
Tripped on a bug, or did a lightbulb lit? Feel free to let us know! If there are not yet opened bug reports, please create one in the issues tracker.