Updated Installation (markdown)

Richard Mwewa
2023-08-25 16:11:30 +02:00
parent 2ede4c34c9
commit c8df6caaf4

@@ -3,16 +3,16 @@
## Installing the CLI
#### Note
> The cli is cross-platform and in order to use it, you will need to have Python installed on your system
### Install rom [PyPI](https://pypi.org/project/reddit-post-scraping-tool)
### Install from [PyPI](https://pypi.org/project/reddit-post-scraping-tool)
```
pip install reddit-post-scraping-tool
```
### Install the dev version from [GitHub](https://github.com/bellingcat/reddit-post-scraping-tool)
### Install the dev version from [Dev branch](https://github.com/bellingcat/reddit-post-scraping-tool/tree/dev)
#### Note
> The dev version might be unstable
```
pip install git+https://github.com/bellingcat/reddit-post-scraping-tool
pip install git+https://github.com/bellingcat/reddit-post-scraping-tool.git@dev
```
### Usage
@@ -27,7 +27,9 @@ rpst --keyword [keyword] --subreddit [subreddit name (without 'r/')]
| -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) |
| -j/--json | | | Specify to log found posts to a json file |
| --json | | | Specify to write found posts to a json file |
| --csv | | | Specify to write found posts to a csv file |
## Setting up the GUI
#### Note