Merge pull request #17 from bellingcat/dev

Dev

README.md

@@ -1,3 +1,4 @@
+![reddit](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/558d31b8-575d-4ab4-a4cf-ec5c41105d12)
 # RPST (Reddit Post Scraping Tool)
 Retrieve **Reddit** posts that contain the specified keyword from a specified subreddit.
 

RPST GUI/RPST/DeveloperBox.vb

@@ -1,17 +0,0 @@
-Public Class DeveloperBox
-    Private Sub DeveloperForm_Load(sender As Object, e As EventArgs) Handles MyBase.Load
-        GreetingLabel.BackColor = Color.Transparent
-        AboutMeLinkLabel.BackColor = Color.Transparent
-        LinkLabelBuyMeACoffee.BackColor = Color.Transparent
-    End Sub
-
-    Private Sub AboutMeLinkLabel_LinkClicked(sender As Object, e As LinkLabelLinkClickedEventArgs) Handles AboutMeLinkLabel.LinkClicked
-        ' I couldn't find a proper way to open a url
-        ' Process.Start() did not work
-        Shell("cmd /c start https://about.me/rly0nheart")
-    End Sub
-
-    Private Sub BuyMeACoffeeLinkLabel_LinkClicked(sender As Object, e As LinkLabelLinkClickedEventArgs) Handles LinkLabelBuyMeACoffee.LinkClicked
-        Shell("cmd /c start https://buymeacoffee.com/_rly0nheart")
-    End Sub
-End Class

RPST GUI/RPST/README.md

@@ -1,44 +1,43 @@
+![reddit](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/558d31b8-575d-4ab4-a4cf-ec5c41105d12)
 # RPST (Reddit Post Scraping Tool)
-Given a subreddit name and a keyword, RPST will return all posts from a specified listing (default is 'top') that contain the provided keyword.
+Retrieve **Reddit** posts that contain the specified keyword from a specified subreddit.
 
 [![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
+## *GUI*
-- [x] Dark mode (*Right-click*)
+- [x] Dark mode (*Right-click*).
-- [x] Saves results to a JSON file (*Right-click*)
+- [x] Saves results to a JSON file (*Right-click*).
-- [x] Logs errors to a file 
+- [x] Logs errors to a file.
+- [x] In-App feature to check for Updates.
 
-## CLI
+## *CLI*
-- [x] Saves results to JSON (*specifiy* `--json`)
+- [x] Saves results to JSON (*specifiy* `--json`).
-- [x] Saves results to CSV (*specify* `--csv`)
+- [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
+- [x] Add manual dark mode option, that will be persistent in all sessions.
-- [ ] Make it save results to a CSV file
+- [x] Make settings persistent in all sessions.
-
+- [x] 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)
-
 
+# 🖥️ 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
+# 🖼️ Screenshots
-If you like `RPST` and would like to show support, you can Buy A Coffee for the developer using the button below
+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)
+***
+<a href="https://www.buymeacoffee.com/_rly0nheart"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=_rly0nheart&button_colour=40DCA5&font_colour=ffffff&font_family=Comic&outline_colour=000000&coffee_colour=FFDD00" /></a>
 
-<a href="https://www.buymeacoffee.com/_rly0nheart" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
+![me](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/21e0bb33-7a84-45d6-92ba-00e40891ba31)
-
-Your support will be much appreciated😊