mirror of
https://github.com/davegallant/rfd.git
synced 2025-08-06 00:33:40 +00:00
Cleanup CLI interface and allow for regular expressions in search (#68)
* Cleanup CLI interface and allow for regular expressions in search * Put a cap on beautifulsoup4
This commit is contained in:
38
README.md
38
README.md
@@ -9,7 +9,8 @@ Hot deals on the command line.
|
||||
[](https://lgtm.com/projects/g/davegallant/rfd/context:python)
|
||||
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
## Install
|
||||
|
||||
@@ -17,19 +18,38 @@ Hot deals on the command line.
|
||||
pip install rfd
|
||||
```
|
||||
|
||||
## Use
|
||||
## Usage
|
||||
|
||||
### view threads
|
||||
```bash
|
||||
rfd threads [--forum-id 9] [--limit 10]
|
||||
```shell
|
||||
Usage: rfd [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
CLI for https://forums.redflagdeals.com
|
||||
|
||||
Options:
|
||||
-v, --version
|
||||
--help Show this message and exit.
|
||||
|
||||
Commands:
|
||||
posts Display all posts in a thread.
|
||||
search Search deals based on a regular expression.
|
||||
threads Displays threads in the forum. Defaults to hot deals.
|
||||
```
|
||||
|
||||
### search
|
||||
```bash
|
||||
rfd search pizza [--num-pages 100]
|
||||
## Examples
|
||||
|
||||
### view hot deals
|
||||
```shell
|
||||
rfd threads
|
||||
```
|
||||
|
||||
## Support Tab Completion
|
||||
### search for pizza
|
||||
```shell
|
||||
rfd search 'pizza'
|
||||
```
|
||||
|
||||
## Tab Completion
|
||||
|
||||
To enable:
|
||||
|
||||
### bash
|
||||
|
||||
|
Reference in New Issue
Block a user