Skip to content

Commit e31270d

Browse files
committed
Readme updated
1 parent 2bebced commit e31270d

File tree

1 file changed

+25
-5
lines changed

1 file changed

+25
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,22 @@ At this moment the application can:
1313
* [Display Purchases Summary](#purchases-summary) (number of store visits and dollars spent)
1414
* [Retrieve Points Balance](#fuel-points-balance)
1515

16-
#### TODO
16+
The script works on kroger.com and other Kroger-owned grocery stores (Ralphs, Fry's, Fred Meyer, Dillons, Food 4 Less, [etc](https://en.wikipedia.org/wiki/Kroger#Chains)).
1717

18-
* Command Line Arguments, to allow something like that: `kroger-cli --clip-digital-coupons`
18+
Install/Download
19+
----------------
20+
21+
### Windows
1922

20-
#### Side Notes
23+
You can download the latest version from the GitHub's [releases tab](https://github.com/Shmakov/kroger-cli/releases).
2124

22-
The initial plan was to use the `requests` package, however I couldn't sign in to the Kroger's website using it. Possibly had to do with csrf token validation. Because of that I had to use `pyppeteer`, which is a python's port of `Puppeteer` (Headless Chrome).
25+
### Linux
26+
27+
* Clone the repository: `git clone [email protected]:Shmakov/kroger-cli.git && cd ./kroger-cli`
28+
* Creating virtual environment: `python3.8 -m venv ./venv` (you might need to install `sudo apt-get install python3.8-venv`)
29+
* And activate it: `source venv/bin/activate`
30+
* Install the requirements: `pip install -r requirements.txt`
31+
* And you should be able to launch the project: `python main.py`
2332

2433
Screenshots
2534
-----------
@@ -42,4 +51,15 @@ Screenshots
4251

4352
### Complete Kroger's Feedback Form
4453

45-
[Watch](images/Kroger-Survey.gif)
54+
[Watch](images/Kroger-Survey.gif)
55+
56+
Side Notes
57+
----------
58+
59+
The initial plan was to use plain HTTP (and `requests` package), however I couldn't sign in to the Kroger's website using it. Possibly had to do with csrf token validation and/or JavaScript-based protection. Because of that I had to use `pyppeteer`, which is a python's port of `Puppeteer` (Headless Chrome).
60+
61+
### TODO
62+
63+
* Command Line Arguments, to allow something like that: `kroger-cli --clip-digital-coupons`
64+
* Purchased items (receipt data) Excel export, which could be useful for budgeting/categorization/filtering
65+
* Notification on when certain items go on sale

0 commit comments

Comments
 (0)