From 7bebff61a8d52649398cfadd14718f7ce6554931 Mon Sep 17 00:00:00 2001 From: Richard Mwewa <74001397+rly0nheart@users.noreply.github.com> Date: Wed, 9 Aug 2023 04:16:39 +0200 Subject: [PATCH] Update README.md --- RPST GUI/RPST/README.md | 42 +++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/RPST GUI/RPST/README.md b/RPST GUI/RPST/README.md index e00d991..3f17a71 100644 --- a/RPST GUI/RPST/README.md +++ b/RPST GUI/RPST/README.md @@ -1,29 +1,35 @@ -# Reddit Post Scraping Tool -Given a subreddit name and a keyword, this script will return all posts from a specified listing (default is 'top') that contain the provided keyword. +# 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. [![Upload Python Package](https://github.com/rly0nheart/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/rly0nheart/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) -![Screenshot 2023-02-10 195818](https://user-images.githubusercontent.com/74001397/218163494-245f6676-1fb3-4680-a6b5-bd15fb1dea5e.png) -![Screenshot_20230210_193329](https://user-images.githubusercontent.com/74001397/218158084-9295abb7-df33-4f86-8df8-e109cac7cde6.png) +![2023-08-08_07-04](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/3c30bf8d-f56b-47fd-948d-d4c667c894f2) +![2023-08-08_07-04_1](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/1675121f-06b6-4b15-bad2-3d5e951bf3bf) -# Features (GUI) -- [x] Auto dark mode from 6pm - 6am -- [x] Saves results to a JSON -- [ ] Other features coming soon... -# TODO (GUI) -- [ ] Make it a stand alone executable -- [ ] Add manual dark mode option, that will be remembered in all sessions -# Wiki +# โœ… Features +## GUI +- [x] Dark mode (Right-click) +- [x] Saves results to a JSON (Right-click) +- [x] Logs errors to a file + +## CLI +- [x] Saves results to a JSON (-j/--json) +- [x] Automatically checks for new updates. Notifies user if update were found. + +# ๐Ÿ“ƒ TODO +## 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 + +# ๐Ÿ“– Wiki [Refer to the Wiki](https://github.com/rly0nheart/reddit-post-scraping-tool/wiki) for installation instructions, in addition to all other documentation. -# Note -> This is one of the projects I am working on, while learning Visual Basic, so the implementation/code may be messed up. If that's the case, please feel free to open a pull request using the available templates. Otherwise, enjoy! +# ๐Ÿ˜ Donations +If you like `RPST` and would like to show support, you can Buy A Coffee for the developer using the button below -# Donations -If you like `Reddit Post Scraping Tool` and would like to show support, you can Buy A Coffee for the developer using the button below - -Buy Me A Coffee +Buy Me A Coffee Your support will be much appreciated๐Ÿ˜Š