From 41e0630be1f6036110d543995a61059d43255e35 Mon Sep 17 00:00:00 2001 From: abs3nt Date: Mon, 16 Jan 2023 18:41:46 -0800 Subject: [PATCH] Update 'Home' --- Home.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/Home.md b/Home.md index a73784c..837a916 100644 --- a/Home.md +++ b/Home.md @@ -48,4 +48,48 @@ zsh: ```/usr/share/zsh/site-functions/_gospt``` fish: ```/usr/share/fish/vendor_completions.d/gospt.fish``` -bash: ```/usr/share/bash-completions/completions/gospt``` \ No newline at end of file +bash: ```/usr/share/bash-completions/completions/gospt``` + +# Usage + +To open the TUI: + +```gospt``` + + +To interact with the CLI: +``` +Usage: + gospt [command] + +Available Commands: + clearradio Wipes the radio playlist and creates an empty one + devices Prints out devices + help Help about any command + like Likes song + link Print link to currently playing song + mute mutes playback + next Skip to next song + nowplaying Shows song and artist of currently playing song + pause Pauses spotify + play Plays spotify + playurl Plays song from provided url + previous goes to previous song + radio Starts radio + refillradio Refills the radio + repeat Toggles repeat + seek seek forward/backward or to a given second + setdevice Shows tui to pick active device + shuffle Toggles shuffle + status Returns player status in json + toggleplay Toggles the play state of spotify + tracks Opens saved tracks + tui Default command, launches the main menu + unlike unlikes song + unmute unmutes playback + volume sets the volume + +Use "gospt [command] --help" for more information about a command. +use "gospt --help" to see this page +``` +` \ No newline at end of file