diff --git a/README.md b/README.md new file mode 100644 index 00000000..6b19be72 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +## :money_with_wings: cheaper + +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Run Python Tests](https://github.com/rahil1304/cheaper/actions/workflows/python-app.yml/badge.svg?branch=main)](https://github.com/rahil1304/cheaper/actions/workflows/python-app.yml) [![DOI](https://zenodo.org/badge/400871267.svg)](https://zenodo.org/badge/latestdoi/400871267) + + +An upcoming chrome extension and API that scrapes the most popular e-commerce websites to get the best deals on the searched query across these websites. + +### What does cheaper do? +Pass any search string to the cheaper API. It can be called by the following command +
cheaper 'Philips Hue Bulb'
+ +The API returns the prices for the searched items from e-commerce websites in JSON format + +``` + { + ts: 1630436269, + website: 'amazon', + searchedString: 'Philips Hue Bulb', + results: [ + { + title: 'Philips Hue White A21 High Lumen Smart Bulb, 1600 Lumens, Bluetooth & Zigbee compatible (Hue Hub Optional), Works with Alexa & Google Assistant', + price: 19.99, + currency: 'USD', + ... + } + ], + ... + } +``` + +### JSON Configuration +Configuration information of the returned JSON + +| Key | Type | Description | +|---------|--------------|------------------------------------| +| ts | ```int``` | Unix timestamp in seconds | +| website | ```string``` | Name of e-commerce website scraped | +| searchedString | ```string``` | String used to search product | +| results | ```list``` | List of results |