Permalink
Browse files

Adding basic readme

  • Loading branch information...
1 parent f41de37 commit 442d1bcbd428683ffe2d63b36d3317dc662735d2 Mark Kahn committed Sep 21, 2011
Showing with 38 additions and 0 deletions.
  1. +38 −0 README.md
View
@@ -0,0 +1,38 @@
+# node-handbrake
+
+A node wrapper for handbrake to encode all video files in a particular folder.
+
+## Usage
+
+First, set up a video profile in handbrake, or use one of the defaults.
+
+```
+Usage: encode_folder [options] folder
+
+Options:
+
+ -h, --help output usage information
+ -v, --version output the version number
+ -R, --recursive Recursively scan directory
+ -d, --delete Delete the original video on successful encoding
+ -f, --force Force over-write of existing files
+ -k, --keep Keep partially encoded files from encoding failures
+ -w, --watch Watch the folder indefinitely for new video files
+ -Z, --preset <name> Handbrake video preset (default: Normal)
+ -H, --handbrake <path> Path to handbrake-cli (default: /Applications/HandBrakeCLI)
+ -c, --cpu <count> Set CPU count (default: autodetected)
+ -x, --extensions <extensions> Comma-separated list of file extensions to process (default: [long list])
+ -X, --outputext <ext> Extension for generated files (default: m4v)
+ -O, --outputfolder <folder> Folder in which to place completed videos (default: same-as-original)
+```
+
+## Sample Execution:
+
+```
+Found File: /Users/markkah/Desktop/08:23:2011/Entertainment_i5.mov
+Found File: /Users/markkah/Desktop/08:23:2011/Entertainment_i3.mov
+Found File: /Users/markkah/Desktop/08:23:2011/Entertainment_i7.mov
+Encoding: Entertainment_i5.mov ✓ Success!
+Encoding: Entertainment_i3.mov ✓ Success!
+Encoding: Entertainment_i7.mov [########### ] 57.93% ETA: 1s
+```

0 comments on commit 442d1bc

Please sign in to comment.