README.rdoc in epubinfo-0.2.2 vs README.rdoc in epubinfo-0.2.3
- old
+ new
@@ -1,8 +1,15 @@
= epubinfo {<img src="https://secure.travis-ci.org/chdorner/epubinfo.png?branch=master" alt="Continuous Integration" />}[http://travis-ci.org/chdorner/epubinfo] {<img src="https://gemnasium.com/chdorner/epubinfo.png" alt="Dependencies" />}[http://gemnasium.com/chdorner/epubinfo]
Extracts metadata information from EPUB files. Supports EPUB2 and EPUB3 formats.
+== Usage
+
+ require 'epubinfo'
+ EPUBInfo.get('path/to/epub/file.epub')
+
+Which returns a +EPUBInfo::Models::Book+ instance, please refer to the {API documentation}[http://rubydoc.info/gems/epubinfo/frames] from here on
+
== Contributing to epubinfo
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.