mirror of
https://github.com/davegallant/rfd.git
synced 2025-08-06 08:43:41 +00:00
Add ToC to README (#90)
This commit is contained in:
25
README.md
25
README.md
@@ -1,13 +1,34 @@
|
||||
# RFD
|
||||
|
||||
This is a CLI utility that allows you to view [Redflagdeals.com](https://forums.redflagdeals.com) on the command line.
|
||||
|
||||
[](https://badge.fury.io/py/rfd)
|
||||
[](https://dependabot.com/)
|
||||
[](https://pepy.tech/project/rfd)
|
||||
|
||||
<!-- BEGIN mktoc -->
|
||||
- [Description](#description)
|
||||
- [Motivation](#motivation)
|
||||
- [Install](#install)
|
||||
- [Usage](#usage)
|
||||
- [View Hot Deals](#view-hot-deals)
|
||||
- [View and Sort Hot Deals](#view-and-sort-hot-deals)
|
||||
- [Search](#search)
|
||||
- [Advanced](#advanced)
|
||||
- [View Posts](#view-posts)
|
||||
- [Shell Completion](#shell-completion)
|
||||
- [bash](#bash)
|
||||
- [zsh](#zsh)
|
||||
<!-- END mktoc -->
|
||||
|
||||
## Description
|
||||
|
||||
This is a CLI utility that allows you to view [Redflagdeals.com](https://forums.redflagdeals.com) on the command line.
|
||||
|
||||

|
||||
|
||||
## Motivation
|
||||
|
||||
It is often faster to use a CLI than to load up a web page and navigate web elements. This tool can search for deals and sort them based on score and views. It is also able to load entire threads for additional analysis.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
|
Reference in New Issue
Block a user