Permalink
Browse files

Updated docs

  • Loading branch information...
matsimitsu committed Dec 4, 2011
1 parent 587a094 commit 58ec7f2ad56945311d7f5f49469f9d9ff8f54aff
Showing with 10 additions and 16 deletions.
  1. +5 −13 README
  2. +5 −3 config-info.yml
View
18 README
@@ -1,18 +1,10 @@
-*Note: I haven't coded in ruby before, so feel free to point out mistakes/corrections, etc, etc.
+SiriTrakt is a Siri Proxy plugin that allows you to ask Siri for your trakt.tv calendar of the evening.
-SiriIMDB is a Siri Proxy plugin that allows you to ask Siri for movie/tv recommendations, get movie/tv show ratings, and retrieve other information about movies/tv shows from IMDB.
-
-SiriIMDB was created by parm289. You are free to use, modify, and redistribute this gem as long as proper credit is given to the original author.
+It's based on SiriIMDB by parm289. You are free to use, modify, and redistribute this gem as long as proper credit is given to the original author.
Usage:
- The currently implemented commands are (where ____ is the title of a movie or TV show):
- "Should I see _____?" - Siri will get the movie/show's rating and suggest whether or not it's worth seeing.
- "How many stars did ____ get?" - Siri will return the movie/show's rating.
- "Who is [was] in ____?" - Siri will tell you the 3 main actors in the movie/show.
- "Who is the lead actor in _____?" - Siri will tell you the lead actor in the movie/tv show.
- "Who directed ____?" - Siri will tell you the director of the movie/show.
- "When was ____ released?" - Siri will return the release date of the movie.
+ The currently implemented commands are (what's on tv tonight?)
+
-
Installation (untested):
- To install SiriIMDB, edit your Siri Proxy config.yml file to include the parameters listed in SiriIMDB' config-info.yml file. Then, run "bundle install" in your Siri Proxy directory to install the SiriIMDB gem.
+ To install SiriTrakt, edit your Siri Proxy config.yml file to include the parameters listed in SiriTrakt' config-info.yml file. Then, run "bundle install" in your Siri Proxy directory to install the SiriTrakt gem.
View
@@ -3,6 +3,8 @@
##########################
#NOTICE: Modifying these options in this file has no effect. You must put them in SiriProxy's config.yml!
##########################
-
- - name: 'SiriIMDB'
- git: 'git://github.com/parm289/SiriProxy-SiriIMDB.git'
+
+ - name: 'SiriTrakt'
+ git: 'git@github.com:matsimitsu/SiritTrakt.git'
+ trakt_api_key: '[your trakt.tv api key here]'
+ trakt_username: '[your trakt username here]'

0 comments on commit 58ec7f2

Please sign in to comment.