From b5b7df868e237531e02f28ca8c9365e45d4e42c6 Mon Sep 17 00:00:00 2001 From: Richard Mwewa <74001397+rly0nheart@users.noreply.github.com> Date: Fri, 25 Aug 2023 15:44:13 +0200 Subject: [PATCH] Update README.md --- README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index fefcda6..fd301b5 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,17 @@ 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/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) -![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) -*** # ✅ Features ## GUI -- [x] Dark mode (Right-click) -- [x] Saves results to a JSON (Right-click) +- [x] Dark mode (*Right-click*) +- [x] Saves results to a JSON file (*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 updates were found. +- [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 @@ -22,6 +20,19 @@ Given a subreddit name and a keyword, RPST will return all posts from a specifie - [x] Add manual dark mode option, that will be persistent in all sessions - [ ] Make it save results to a CSV file +# Images +## 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-33](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/145016bd-57c8-48f5-91a9-76e26d0ac26e) +* ![2023-08-25_15-35](https://github.com/bellingcat/reddit-post-scraping-tool/assets/74001397/47ba23ad-8d32-49c5-8c16-34a903fbc581) + + + + # 📖 Wiki [Refer to the Wiki](https://github.com/bellingcat/reddit-post-scraping-tool/wiki) for installation instructions, in addition to all other documentation.