]> git.r.bdr.sh - rbdr/lyricli.rb/blobdiff - README.md
Update README
[rbdr/lyricli.rb] / README.md
index 49ad05b2cc569fd7ba7089261cadb7f9ee8dd643..a056746ea0b35f1cc5b087eab5ade9752a43080e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,7 @@
-# Lyricli #
+# Lyricli.rb (Deprecated)
+
+The repository is intended only as an archive for the former ruby version of lyricli
+
 ## The command line client for lyrics ##
 
 This is a quick introduction for Lyricli. Right now it's in really early
 ## The command line client for lyrics ##
 
 This is a quick introduction for Lyricli. Right now it's in really early
@@ -8,10 +11,7 @@ see how to get it working.
 
 ### Installing ###
 
 
 ### Installing ###
 
-1. Clone this Repo
-2. `gem build lyricli.gemspec`
-3. `gem install lyricli-0.0.1.gem`
-4. Voila!
+`gem install lyricli`
 
 ### Usage ###
 
 
 ### Usage ###
 
@@ -41,6 +41,14 @@ commands:
 * `lrc -v` or `lrc --version` show the installed version of lyricli.
 * `lrc -h` or `lrc --help` display some help
 
 * `lrc -v` or `lrc --version` show the installed version of lyricli.
 * `lrc -h` or `lrc --help` display some help
 
+#### It always gives me rdio even if using iTunes ####
+
+Due to the way the rdio API works, we can't tell if you're actively
+listen and it always returns the last song. Currently the best way to
+have the sources correctly is to enable **rdio first** and then
+**itunes**. If you enabled itunes first, you can just disable and
+re-enable and it should fix it.
+
 ### Roadmap ###
 
 There is not much defined right now as a roadmap, but this needs to be
 ### Roadmap ###
 
 There is not much defined right now as a roadmap, but this needs to be
@@ -57,10 +65,10 @@ Also, I want to add the last song to the configuration, so you can check
 that. This would let us "watch" lyricli without hammering the lyrics
 wiki api
 
 that. This would let us "watch" lyricli without hammering the lyrics
 wiki api
 
+Also, during the enable phase, sources like iTunes should check for
+proper OS and stop if they're not in their home turf.
+
 ### Leave Feedback Please! ###
 
 If you decide to use or hack away at Lyricly, please don't forget to
 post any issues you find.
 ### Leave Feedback Please! ###
 
 If you decide to use or hack away at Lyricly, please don't forget to
 post any issues you find.
-
-### License ###
-Licensed under 3-clause-BSD.