Added a README

2024-03-23 01:27:07 -04:00
parent e5c5c631ec
commit 3ca053a8e1
2 changed files with 31 additions and 5 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,26 @@
+# coin
+Something to coin the items on your receipts
+
+## Why coin?
+Because normal humans can't decipher what's on the Walmart receipts.
+
+
+## How does coin work?
+First, coins pulls the UPC and price info off of the given Walmart
+receipt.
+
+Then, coin matches the name with the UPC (Yes! No more scratching your
+head against seemingly random Walmart abbreviations for items!) using
+a scraper.
+
+Finally, it stores your shopping trip in a spreadsheet (.csv format).
+
+
+## Dependencies
+-   Python
+-   PyQt6
+-   pytesseract
+-   OpenCV (On Python)
+-   PIL
+-   Selenium (undetected, with a suitable chromedriver)
+