Permalink
Browse files

update the README

  • Loading branch information...
eregon committed Jul 27, 2011
1 parent b9f991c commit 455ee3131ae72f7223f40512d87f180c866782d3
Showing with 12 additions and 8 deletions.
  1. +12 −8 README.md
View
@@ -2,22 +2,26 @@
Find and download subtitles
-suby is a little script to find and download subtitles for TV series
+`suby` is a little script to find and download subtitles for TV series
## Install
gem install suby
## Synopsis
- suby 'my show 1x01 - Pilot.avi' # => Downloads my show 1x01 - Pilot.srt
+ suby 'My Show 1x01 - Pilot.avi' # => Downloads 'My Show 1x01 - Pilot.srt'
-## Status
+## Features
-Under heavy development.
+* Parse filename to detect show, season and episode
+* Search and download appropriate subtitle, extracting it from the archive and renaming it
+* Accept a lang option (defaults to en)
+* Try multiple sites, falling back on the next one if it was not found on the current
+* Detailed error messages
-* Currently only accept one format for input.
- You could use [tvnamer](https://github.com/dbr/tvnamer) to rename the video files before.
+## TODO
-* Search only on tvsubtitles.net.
- Many series have subtitles there, but not all.
+* usual movies support (via opensubtitles.org)
+* multi-episodes support
+* choose wiser the right subtitle if many are available

0 comments on commit 455ee31

Please sign in to comment.