Skip to content

Commit

Permalink
add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
port19x committed Dec 26, 2022
1 parent eb35bfa commit 7b59e10
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Redqu

*A reddit rss media queue extractor*

## 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.

I like the following
```sh
mpv --fs $(java -jar redqu-1.0.jar cats)
```

Sometimes reddit is grumpy and doesn't wanna cooperate.
Just try again.
The relevant error message: `Reddit 429 Too Many Requests. Try Again.`

## Installation

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

Check the releases and download the .jar file.

## Building from Source

```sh
clj -T:build uber
```

0 comments on commit 7b59e10

Please sign in to comment.