From bb7236069968a3c1af446743bfffd8ee777be19c Mon Sep 17 00:00:00 2001 From: Richard Mwewa <74001397+rly0nheart@users.noreply.github.com> Date: Wed, 30 Aug 2023 03:19:55 +0200 Subject: [PATCH] Update README.md --- RPST GUI/RPST/README.md | 50 ++++++++++++++++++++--------------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/RPST GUI/RPST/README.md b/RPST GUI/RPST/README.md index 52ea2a6..866d077 100644 --- a/RPST GUI/RPST/README.md +++ b/RPST GUI/RPST/README.md @@ -4,41 +4,39 @@ Given a subreddit name and a keyword, RPST will return all posts from a specifie [![Upload Python Package](https://github.com/bellingcat/reddit-post-scraping-tool/actions/workflows/python-publish.yml/badge.svg)](https://github.com/rly0nheart/reddit-post-scraping-tool/actions/workflows/python-publish.yml) [![CodeQL](https://github.com/bellingcat/reddit-post-scraping-tool/actions/workflows/codeql.yml/badge.svg)](https://github.com/rly0nheart/reddit-post-scraping-tool/actions/workflows/codeql.yml) ![.Net](https://img.shields.io/badge/.NET-5C2D91?style=flat&logo=.net&logoColor=white) ![Python](https://img.shields.io/badge/python-3670A0?style=flat&logo=python&logoColor=ffdd54) # โœ… Features -## GUI -- [x] Dark mode (*Right-click*) -- [x] Saves results to a JSON file (*Right-click*) -- [x] Logs errors to a file +## *GUI* +- [x] Dark mode (*Right-click*). +- [x] Saves results to a JSON file (*Right-click*). +- [x] Logs errors to a file. +- [x] In-App feature to check for Updates. -## CLI -- [x] Saves results to JSON (*specifiy* `--json`) -- [x] Saves results to CSV (*specify* `--csv`) +## *CLI* +- [x] Saves results to JSON (*specifiy* `--json`). +- [x] Saves results to CSV (*specify* `--csv`). - [x] Automatically checks for new updates, and notifies user if updates were found. # ๐Ÿ“ƒ TODO -## GUI +## *GUI* - [ ] Make it installable with a setup.exe/setup.msi file. -- [x] Add manual dark mode option, that will be persistent in all sessions -- [ ] Make it save results to a CSV file - -# Images & Screenshots -## GUI -* ![2023-08-09_04-05](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/d8917a35-3eac-44ce-aa96-1f9685095254) -* ![2023-08-09_04-05_1](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/d2fe7269-91d4-49ad-87fb-44282c5637a7) - -## CLI -* ![2023-08-25_15-39](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/4bca09b3-271f-452d-81a7-39c9986539f2) -* ![2023-08-25_15-30](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/2b39bdfa-87d0-4038-90cd-14e7d3b6a84b) -* ![2023-08-25_15-35](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/47ba23ad-8d32-49c5-8c16-34a903fbc581) - +- [x] Add manual dark mode option, that will be persistent in all sessions. +- [x] Make settings persistent in all sessions. +- [x] Make it save results to a CSV file. +# ๐Ÿ–ฅ๏ธ Tested environments +## *GUI* +- [x] Microsoft Windows 11 +## *CLI* +- [x] Android Termux +- [x] Microsoft Windows 11 +- [x] Ubuntu 22.04 - latest versions # ๐Ÿ“– Wiki [Refer to the Wiki](https://github.com/bellingcat/reddit-post-scraping-tool/wiki) for installation instructions, in addition to all other documentation. -# ๐Ÿ˜ Donations -If you like `RPST` and would like to show support, you can Buy A Coffee for the developer using the button below +# ๐Ÿ–ผ๏ธ Screenshots +You can view a collection of screenshots for both the *CLI* and *GUI* [here](https://github.com/bellingcat/reddit-post-scraping-tool/tree/master/images) +*** + -Buy Me A Coffee - -Your support will be much appreciated๐Ÿ˜Š +![me](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/21e0bb33-7a84-45d6-92ba-00e40891ba31)