From ae52fcbd30e135dfe743f0e196334f37eb2dda7e Mon Sep 17 00:00:00 2001
From: Richard Mwewa <74001397+rly0nheart@users.noreply.github.com>
Date: Tue, 28 Jun 2022 23:29:20 +0200
Subject: [PATCH] Update README.md

---
 README.md | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 078d4d6..595a05b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# reddit-post-scraping-tool
-Reddit post scraping tool
+Given a subreddit name and a keyword, this script will return all top (by default) posts that contain the specified word.
+
+## Installation
+```
+git clone https://github.com/rly0nheart/reddit-post-scraping-tool.git
+```
+
+```
+cd reddit-post-scraping-tool
+```
+
+## Usage
+```
+python reddithposthscrapinghtool.py --keyword [keyword] --subreddit [subreddit]
+```
+
+## Optional arguments
+| Option       | Argument    | Choices    | Usage     |
+| -------------|:-----------:|-----------:|:---------:|
+| -l/--listing | LISTING     | [controversial, hot, best, new, rising]  |  listing: controversial, hot, best, new, rising (default: top)  |
+| -c/--limit   | NUMBER      | 1-100      |  results limit (default: 10)|
+| -t/--timeframe| TIMEFRAME  | [hour, day, week, month, year]           |  timeframe: hour, day, week, month, year (default: all) |
+
+Happy hunting!✌🏾😎