Skip to content

Commit 67112c8

Browse files
docs: add data structure section to README with column mappings for Google Sheet
1 parent 3d1b19f commit 67112c8

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,19 @@ Run the generation script:
7979
bun run gen
8080
```
8181

82+
### Data Structure
83+
84+
The application expects specific columns in the source Google Sheet. These are mapped to short keys to minimize the JSON file size.
85+
86+
| Sheet Column Name | Key | Description |
87+
|-------------------|-----|-------------|
88+
| Name | `n` | Store Name |
89+
| URL | `u` | Store URL (https:// stripped) |
90+
| Shoppers 30d | `s30` | Shoppers count (30 days) |
91+
| Avg Savings 30d | `a30` | Average savings (30 days) |
92+
| Affiliate URL | `p` | Has affiliate link (1 = Yes, 0 = No) |
93+
| Number of Visible Coupons | `c` | Coupon count |
94+
8295
### Running the App
8396

8497
Start the development server:

0 commit comments

Comments
 (0)