git.r.bdr.sh - rbdr/lyricli.rb/blob - README.md

   1 # Lyricli #
   2 ## The command line client for lyrics ##
   3
   4 This is a quick introduction for Lyricli. Right now it's in really early
   5 stages of development, so it's lacking in a lot of stuff (mainly tests
   6 and documentation) ... But it generally works and here's a tutorial to
   7 see how to get it working.
   8
   9 ### Installing ###
  10
  11 `gem install lyricli`
  12
  13 ### Usage ###
  14
  15 Lyricli can be invoked with the command `lrc` and there are three basic
  16 ways of using it:
  17
  18 `lrc`
  19
  20 When you run it without arguments, it will look in the available sources
  21 to try to find a playing song and extract the lyrics.
  22
  23 `lrc artist song`
  24
  25 When you run it with arguments, it will use them to search for the
  26 lyrics. This won't work if you manually disable the arguments source in
  27 your configuration file.
  28
  29 #### Commands ####
  30
  31 The third way to use it is by passing it one of the following special
  32 commands:
  33
  34 * `lrc -l` or `lrc --list-sources` lists the available sources.
  35 * `lrc -e` or `lrc --enable SOURCE` enable a source from the list.
  36 * `lrc -d` or `lrc --disable SOURCE` disable a source from the list.
  37 * `lrc -r` or `lrc --reset SOURCE` reset all configuration for a source.
  38 * `lrc -v` or `lrc --version` show the installed version of lyricli.
  39 * `lrc -h` or `lrc --help` display some help
  40
  41 #### It always gives me rdio even if using iTunes ####
  42
  43 Due to the way the rdio API works, we can't tell if you're actively
  44 listen and it always returns the last song. Currently the best way to
  45 have the sources correctly is to enable **rdio first** and then
  46 **itunes**. If you enabled itunes first, you can just disable and
  47 re-enable and it should fix it.
  48
  49 ### Roadmap ###
  50
  51 There is not much defined right now as a roadmap, but this needs to be
  52 done:
  53
  54 * Specs for all the components
  55 * YARD documentation for all the components
  56
  57 And the first thing I want to work on after that is done is separating
  58 the Lyrics Engines so we can add/remove lyrics engines in a similar way to how
  59 we currently add/remove sources.
  60
  61 Also, I want to add the last song to the configuration, so you can check
  62 that. This would let us "watch" lyricli without hammering the lyrics
  63 wiki api
  64
  65 Also, during the enable phase, sources like iTunes should check for
  66 proper OS and stop if they're not in their home turf.
  67
  68 ### Leave Feedback Please! ###
  69
  70 If you decide to use or hack away at Lyricly, please don't forget to
  71 post any issues you find.
  72
  73 ### License ###
  74 Licensed under 3-clause-BSD.