Skip to content

Commit 2bebced

Browse files
committed
Readme updated
1 parent e53565b commit 2bebced

File tree

7 files changed

+35
-5
lines changed

7 files changed

+35
-5
lines changed

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,45 @@
11
Kroger CLI
22
==========
33

4+
![Display Purchases Summary](images/Purchases-Summary.gif)
5+
46
The idea of the project is to create a command line utility that can automate certain tasks on the Kroger's website.
57

6-
At this moment in time the application can:
8+
At this moment the application can:
9+
10+
* Display basic information from your account (name, address, rewards card number, etc)
11+
* [Complete the Kroger’s Survey on your behalf](images/Kroger-Survey.gif) (to earn 50 points and enter the sweepstake)
12+
* [Clip all Digital Coupons](#clip-digital-coupons) (first 150 coupons only, sorted by relevance)
13+
* [Display Purchases Summary](#purchases-summary) (number of store visits and dollars spent)
14+
* [Retrieve Points Balance](#fuel-points-balance)
715

8-
* Display basic information from your account
9-
* Clip all digital coupons
16+
#### TODO
1017

11-
![Kroger CLI Screenshot](images/cli-screenshot.png)
18+
* Command Line Arguments, to allow something like that: `kroger-cli --clip-digital-coupons`
1219

1320
#### Side Notes
1421

15-
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).
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).
23+
24+
Screenshots
25+
-----------
26+
27+
### Main Interface
28+
29+
![Kroger CLI Screenshot](images/Home-Screen-Screenshot.png)
30+
31+
### Clip Digital Coupons
32+
33+
![Clip all Kroger's Digital Coupons](images/Clip-Digital-Coupons.png)
34+
35+
### Purchases Summary
36+
37+
![Display Purchases Summary](images/Purchases-Summary.gif)
38+
39+
### Fuel Points Balance
40+
41+
![Fuel Points Balance](images/Fuel-Points-Balance.png)
42+
43+
### Complete Kroger's Feedback Form
44+
45+
[Watch](images/Kroger-Survey.gif)

images/Clip-Digital-Coupons.png

25.6 KB
Loading

images/Fuel-Points-Balance.png

19.4 KB
Loading

images/Home-Screen-Screenshot.png

22.5 KB
Loading

images/Kroger-Survey.gif

1.6 MB
Loading

images/Purchases-Summary.gif

51.6 KB
Loading

images/cli-screenshot.png

-20.1 KB
Binary file not shown.

0 commit comments

Comments
 (0)