Permalink
Browse files

Writing README and updating manifest license and rakefile.

  • Loading branch information...
Jan Friedrich
Jan Friedrich committed Jan 27, 2010
1 parent 6d8c732 commit 6e83f1e57d982bbbda4f766b2d33dcc1bd464f48
Showing with 96 additions and 4 deletions.
  1. +1 −1 LICENSE
  2. +3 −2 Manifest
  3. +90 −0 README
  4. +2 −1 Rakefile
View
@@ -1,6 +1,6 @@
The MIT License
-Copyright (c) 2009 Jan Friedrich
+Copyright (c) 2009-2010 Jan Friedrich
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
View
@@ -1,10 +1,11 @@
CHANGELOG
LICENSE
Manifest
+README
Rakefile
examples/01_simple_reading.rb
examples/02_simple_writing.rb
-examples/03_reading_with_grouping.rb
+examples/03_reading_using_groups.rb
lib/multi_exiftool.rb
lib/multi_exiftool/executable.rb
lib/multi_exiftool/reader.rb
@@ -13,5 +14,5 @@ lib/multi_exiftool/writer.rb
test/helper.rb
test/test_reader.rb
test/test_values.rb
-test/test_values_grouping.rb
+test/test_values_using_groups.rb
test/test_writer.rb
View
90 README
@@ -0,0 +1,90 @@
+= MultiExiftool
+
+== Description
+
+This library is wrapper for the Exiftool command-line application
+(http://www.sno.phy.queensu.ca/~phil/exiftool) written by Phil Harvey.
+It is designed for dealing with multiple files at once by creating
+commands to call exiftool with various arguments, call it and parsing
+the results.
+
+== Examples
+
+=== Reading
+
+ require 'multi_exiftool'
+
+ reader = MultiExiftool::Reader.new
+ reader.filenames = Dir['*.jpg']
+ results = reader.read
+ results.each do |values|
+ puts "#{values.file_name}: #{values.comment}"
+ end
+
+=== Writing
+
+ require 'multi_exiftool'
+
+ writer = MultiExiftool::Writer.new
+ writer.filenames = Dir['*.jpg']
+ writer.values = {creator: 'Jan Friedrich', copyright: 'Public Domain'}
+ if writer.write
+ puts 'ok'
+ else
+ puts writer.errors.join
+ end
+
+=== Further Examples
+
+See the examples in the examples directory.
+
+
+== Requirements
+
+- Ruby 1.9.1 or higher
+- An installation of the Exiftool command-line application.
+ Instructions for installation you can find under
+ http://www.sno.phy.queensu.ca/~phil/exiftool/install.html .
+
+== Installation
+
+First you need Exiftool (see under Requirements above). Then you can simply
+install the gem with
+ gem install multi_exiftool
+
+== Contribution
+
+The code is also hostet in a git repository on Gitorious at
+http://gitorious.org/multi_exiftool
+or
+http://github.com/janfri/multi_exiftool-redesign
+feel free to contribute!
+
+== Author
+
+Jan Friedrich (janfri26 AT gmail DOT com)
+
+== Copyright / License
+
+ The MIT License
+
+ Copyright (c) 2009-2010 Jan Friedrich
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+
View
@@ -3,7 +3,8 @@ require 'echoe'
Echoe.new('multi_exiftool') do |p|
p.author = 'Jan Friedrich'
p.email = 'janfri26@gmail.com'
- p.summary = 'An alternative approach for a ruby interface to the exiftool command-line application for better dealing with mass processing than MiniExiftool.'
+ p.summary = 'This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool).'
+ p.description = 'This library is wrapper for the Exiftool command-line application (http://www.sno.phy.queensu.ca/~phil/exiftool) written by Phil Harvey. It is designed for dealing with multiple files at once by creating commands to call exiftool with various arguments, call it and parsing the results.'
p.ruby_version = '>=1.9.1'
p.url = 'http://rubyforge.org/projects/multiexiftool'
p.install_message = %q{

0 comments on commit 6e83f1e

Please sign in to comment.