From 82cd4a4e33dbb149f2cd12cc06f38015620c87e7 Mon Sep 17 00:00:00 2001
From: Andy Killorin <37423245+Speedy6451@users.noreply.github.com>
Date: Mon, 30 Oct 2023 18:58:48 -0500
Subject: [PATCH] added readme.md

---
 readme.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..c5cf154
--- /dev/null
+++ b/readme.md
@@ -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"`