docs: add readme

izn · Jun 9, 2024 · db4c781 · db4c781
1 parent 639199d
commit db4c781
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# lyrify 
+[![Go](https://github.com/izn/lyrify/actions/workflows/go.yml/badge.svg)](https://github.com/izn/lyrify/actions/workflows/go.yml)
+
+experimental terminal-based code to get lyrics based on current playing song on spotify desktop client **(darwin-only)**.
+
+![Demo](https://github.com/izn/lyrify/blob/main/demo.gif)
+
+### setup
+```sh
+go install .
+```
+
diff --git a/demo.gif b/demo.gif
diff --git a/demo.tape b/demo.tape
@@ -0,0 +1,14 @@
+Output demo.gif
+
+Require echo
+
+Set Shell "bash"
+Set FontSize 24
+Set Width 700
+Set Height 650 
+
+Type "lyrify" 
+Sleep 500ms  
+Enter
+
+Sleep 5s