From b9edb7d201a26c21d3e55b2f1bf87623d9d5c21e Mon Sep 17 00:00:00 2001
From: port19 <port19@port19.xyz>
Date: Mon, 30 Jan 2023 16:44:45 +0100
Subject: [PATCH] updated docs

---
 readme.md | 34 +++++++++++++++++-----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

diff --git a/readme.md b/readme.md
index 7ebe5b6..070e841 100644
--- a/readme.md
+++ b/readme.md
@@ -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
 ```