Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
port19x authored Jan 30, 2023
1 parent 489d821 commit b9edb7d
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# Redqu
[![bb compatible](https://raw.githubusercontent.com/babashka/babashka/master/logo/badge.svg)](https://babashka.org)

*A reddit rss media queue extractor*

![Showcase](https://user-images.githubusercontent.com/82055622/209588571-310b3e87-a39f-4baf-b2bd-7a9348dccd44.png)
## Usage

Provide a subreddit name as an input.
Extraction is hardcoded to be top of week for now.
Redqu outputs a bunch of links, get creative.
## Usage

Example:
```sh
mpv $(redq cats)
mpv $(redq cats top hour)
mpv $(redq cats new)
```
*Redqu outputs a bunch of links, get creative.*

Sometimes reddit is grumpy and doesn't wanna cooperate.
Just try again.
The relevant error message: `Reddit 429 Too Many Requests. Try Again.`
Provide a subreddit name, a sort method and timeframe as an input.\
Accepted sort methods: `hot new top rising controversial` \
Default sort method: `top` \
Accepted time frames: `hour day week month year all` \
Default time frame: `week`

## Installation
## Dependencies

Dependency Alert: you need some sort of java runtime for this.
Babashka

```sh
sudo curl -sL github.com/port19x/redqu/raw/main/redq -o /usr/local/bin/redq &&
sudo curl -sL github.com/port19x/redqu/raw/main/redqu-1.0.jar -o /usr/local/bin/redqu-1.0.jar &&
sudo chmod +x /usr/local/bin/redq
```
## Installation

## Building from Source
I'll provide a PKGBUILD soon-ish.

```sh
clj -T:build uber
yay -S babashka-bin
sudo curl -sL github.com/port19x/redqu/raw/main/redqu -o /usr/local/bin/redqu &&
sudo chmod +x /usr/local/bin/redqu
```

0 comments on commit b9edb7d

Please sign in to comment.