Update README.md

README.md

@@ -1,3 +1,83 @@
----
-license: cc-by-nc-sa-4.0
----
+---
+license: cc-by-nc-sa-4.0
+language:
+- bn
+- en
+---
+
+
+# BanglishRev: A Large-Scale Bangla-English and Code-mixed Dataset of Product Reviews in E-Commerce
+
+## Description
+
+This work presents the BanglishRev Dataset, the largest e-commerce product review dataset to date for reviews written in Bengali, English, a mixture of both and Banglish, Bengali words written with English alphabets. The dataset comprises of 1.74 million written reviews from 3.2 million ratings information collected from a total of 128k products being sold in online e-commerce platforms targeting the Bengali population. It includes an extensive array of related metadata for each of the reviews including the rating given by the reviewer, date the review was posted and date of purchase, number of likes, dislikes, response from the seller, images associated with the review etc. 
+
+## Dataset Structure
+
+The dataset is structured as a JSON file with the following fields:
+- Product ID : Meta-data of the product.
+  - `Number Of Reviews`: The total number of reviews for a product.
+  - `Reviews`: A list of review objects.
+    - `Buyer ID`: The ID of the buyer.
+    - `Current Rating`: The rating given by the buyer.
+    - `Review Content`: The content of the review.
+    - `Review Date`: The date the review was posted.
+    - `Likes`: Number of likes for the review.
+    - `Dislikes`: Number of dislikes for the review.
+    - `Date Bought`: The date the product was bought.
+    - `Reply`: Any replies to the review.
+    - `Images`: List of image URLs associated with the review.
+  - `Average Rating`: The average rating for the product.
+  - `Score Counts`: The count of each rating (1 star to 5 stars) given to the product.
+  - `Category`: The category of the product.
+  - `Parent Category`: The parent category of the product.
+  - `Root Category`: The root category of the product.
+
+## Example Entry
+
+```json
+{
+    "1400200": {
+        "Number Of Reviews": 2,
+        "Reviews": [
+            {
+                "Buyer ID": 1763002,
+                "Current Rating": "1",
+                "Review Content": "খুব ভালো কাবার",
+                "Review Date": "2024-02-15",
+                "Likes": "1",
+                "Dislikes": "0",
+                "Date Bought": "2024-02-07",
+                "Reply": "অসংখ্য ধন্যবাদ সার 🥰🥰🥰",
+                "Images": [
+                    {
+                        "Image URL": "https://sg-test-11.slatic.net/other/roc/00eda86ee26b963f0078929385388a11.jpg",
+                        "Image Directory": "Review Images/review-306854002-1-1.jpg"
+                    }
+                ]
+            },
+            {
+                "Buyer ID": 1338289,
+                "Current Rating": "5",
+                "Review Content": "Khob valo.... kinto selar shobidha jonok naa",
+                "Review Date": "2023-06-25",
+                "Likes": "0",
+                "Dislikes": "0",
+                "Date Bought": "2023-06-09",
+                "Reply": "ধন্যবাদ সার 🥰🥰🥰🥰🥰",
+                "Images": []
+            }
+        ],
+        "Average Rating": 3.0,
+        "Score Counts": {
+            "1 Star": "1",
+            "2 Star": "0",
+            "3 Star": "0",
+            "4 Star": "0",
+            "5 Star": "1"
+        },
+        "Category": "Phone Cases",
+        "Parent Category": "Trendy Mobile Accessories",
+        "Root Category": "Electronics Device"
+    }
+}