Skip to content

Commit

Permalink
Readme and license.
Browse files Browse the repository at this point in the history
  • Loading branch information
notahat committed Jan 24, 2011
1 parent 611ed50 commit 6af0c0d
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 3 deletions.
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Copyright (c) 2010 Envato & Pete Yandell.

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.
48 changes: 48 additions & 0 deletions README.rdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
= Exiv2

A simple wrapper around the C++ Exiv2 libary for reading image metadata.

See http://www.exiv2.org/

== Usage

gem install exiv2

require 'exiv2'
image = Exiv2::ImageFactory.open("image.jpg")
image.read_metadata
puts image.exif_data.inspect
puts image.iptc_data.inspect

== Why?

None of the existing Ruby libraries for reading image metadata did quite what
we wanted, so we figured it wouldn't be too hard to wrap enough of Exiv2 to
meet our needs.

The intention is to just mirror the Exiv2 API in Ruby, so the path to extending
this to support more of Exiv2's functionality should be straightforward. Patches
are welcome.

== Compatibility

Tested with Ruby 1.8.7 and Exiv2 0.21.

== Developing

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

== Status

In early development. Very little of Exiv2's API is supported, and it hasn't
been heavily tested.

== Copyright

Copyright (c) 2010 Envato & Pete Yandell. See LICENSE for details.
6 changes: 3 additions & 3 deletions exiv2.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Gem::Specification.new do |s|
s.platform = Gem::Platform::RUBY
s.authors = ["Pete Yandell"]
s.email = ["pete@envato.com"]
s.homepage = ""
s.summary = %q{A simple wrapper around exiv2}
s.description = %q{A simple wrapper around the C++ exiv2 libary for reading image metadata}
s.homepage = "https://github.com/envato/exiv2"
s.summary = %q{A simple wrapper around Exiv2}
s.description = %q{A simple wrapper around the C++ Exiv2 libary for reading image metadata}

s.rubyforge_project = "exiv2"

Expand Down

0 comments on commit 6af0c0d

Please sign in to comment.