README.rdoc in movie-renamer-0.0.12 vs README.rdoc in movie-renamer-0.0.15
- old
+ new
@@ -1,28 +1,41 @@
= movie-renamer
A simple command line interface to rename movies in a folder
+and get your movies collection organized!
+It works in an interactive way and
+uses imdb gem to query imdb about current movie trying to obtain useful infos
-Uses imdb gem to query imdb about current movie trying to obtain useful infos
-
to see the usage type
$ movie-renamer -h
+Usage: movie-renamer [-i|-s|-f|-h|-p] <folder>
+Default behavior is -f on current working directory
+ -h, --help Display this help
+ -i, --imdb Executes a query on imdb on <movie name>
+ -s, --singlemovie FILE Acts on a single movie file <file name>
+ -f, --folder FOLDER Acts on whole folder <folder>
+ -p, --path PATH path for moving renamed movies default is tmp/ in current working directory
+
== How it works
Default behavior is to scan the current working directory
For each movie in the folder a question about what to do is asked.
Then movie is renamed using input provided by the user
+You can query imdb using the filename or enter use manual search
-Each renamed movie is moved into a tmp/ subfolder of the current working directory.
-Movies are renamed like this:
+Each renamed movie is moved into a tmp/ subfolder of the current working directory or
+in the folder specified with the -p option
-YEAR - DIRECTOR - TITLE - optionalPART.extension
+By default Movies are renamed like this:
+$year - $director - $title partXX.file_extension
+You can set the rename pattern creating a .movie-renamer file in your home
-There are plans to add the rename pattern like an optional parameter
+example:
+filename: ($year) - $title - $director
== Note on Patches/Pull Requests