added readme.md
This commit is contained in:
parent
21548510fc
commit
82cd4a4e33
1 changed files with 18 additions and 0 deletions
18
readme.md
Normal file
18
readme.md
Normal file
|
@ -0,0 +1,18 @@
|
|||
# Funring
|
||||
|
||||
A fun ring for your system tray that shows the status of the currently playing song
|
||||
|
||||
`funring [player]`
|
||||
|
||||
written with swaybar on arch linux in mind
|
||||
|
||||
### Installation
|
||||
|
||||
1. `cargo install --path .`
|
||||
|
||||
### Usage
|
||||
|
||||
1. Start spotify or another [mpris compatible music player](https://wiki.archlinux.org/title/MPRIS#Supported_clients)
|
||||
2. `funring`
|
||||
|
||||
if the wrong player is selected by default, pass a name i.e. `funring "Pragha Music Player"`
|
Loading…
Reference in a new issue