From 6e9f97c444396641397ba8368cbc043da59b36f2 Mon Sep 17 00:00:00 2001 From: Richard Mwewa <74001397+rly0nheart@users.noreply.github.com> Date: Sun, 6 Aug 2023 04:45:36 +0200 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 15f9871..7fad897 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,33 @@ -# Reddit Post Scraping Tool +# RPST (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. [![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-06_04-30](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/e924ec32-8786-41ab-af59-bd5fca0cdb57) +![2023-08-06_04-32](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/04d6de20-2e02-4dea-a1cc-30c611802acf) -# Features (GUI) + + +# ✅ Features +## GUI - [x] Dark mode (Right-click) - [x] Saves results to a JSON (Right-click) -- [ ] Other features coming soon... +- [x] Logs errors to a file -# TODO (GUI) -- [ ] Make it a stand alone executable -- [x] Add manual dark mode option, that will be remembered in all sessions +## 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 +# 📖 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 +# 😁 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