feat: Create a README

DarkVanityOfLight · Feb 13, 2022 · 4cdedf4 · 4cdedf4
1 parent bd292c8
commit 4cdedf4
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,5 @@
+# Spolylyr
+Spolylyr is a polybar module that displays the current lyrics for a song playing on spotify. For this to work you have to install the SpotifyLyricServer via Spicetify.
+
+## How it works
+Spolylyr uses Flasks SocketIO to recieve the lyrics and the current time. Flask is served with gunicorn and the gventlet web socket backend.