ReadMe.rdoc in ucf-1.1.0 vs ReadMe.rdoc in ucf-2.0.0

- old
+ new

@@ -3,16 +3,16 @@ Authors:: Robert Haines Contact:: mailto:support@mygrid.org.uk Homepage:: http://mygrid.github.io/ruby-ucf Source code:: https://github.com/myGrid/ruby-ucf Licence:: BSD (See Licence file or http://www.opensource.org/licenses/bsd-license.php) -Copyright:: (c) 2013, 2014 The University of Manchester, UK +Copyright:: (c) 2013-2015 The University of Manchester, UK -{<img src="https://badge.fury.io/rb/ucf.png" alt="Gem Version" />}[http://badge.fury.io/rb/ucf] -{<img src="https://codeclimate.com/github/myGrid/ruby-ucf.png" />}[https://codeclimate.com/github/myGrid/ruby-ucf] +{<img src="https://badge.fury.io/rb/ucf.svg" alt="Gem Version" />}[http://badge.fury.io/rb/ucf] +{<img src="https://codeclimate.com/github/myGrid/ruby-ucf.svg" />}[https://codeclimate.com/github/myGrid/ruby-ucf] {<img src="https://travis-ci.org/myGrid/ruby-ucf.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/myGrid/ruby-ucf] -{<img src="https://coveralls.io/repos/myGrid/ruby-ucf/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myGrid/ruby-ucf?branch=master] +{<img src="https://coveralls.io/repos/myGrid/ruby-ucf/badge.svg?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/myGrid/ruby-ucf?branch=master] == Synopsis This is a Ruby library for working with UCF documents. See {the specification}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format] @@ -48,9 +48,28 @@ this API into closer alignment with the underlying {zip-container API}[http://mygrid.github.io/ruby-zip-container/] (ZipContainer::File). UCF::Container is not available from version 1.0.0 onwards. + +== Usage + +This library has two entry points. + +The main UCF::File class is a specialization of +{ZipContainer::File}[http://mygrid.github.io/ruby-zip-container/3.0.0/ZipContainer/File.html] +which largely mimics the rubyzip +{Zip::File}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/File] and +{Zip::FileSystem}[http://www.rubydoc.info/gems/rubyzip/1.1.6/Zip/FileSystem] +APIs. + +The UCF::Dir class is a based upon the +{ZipContainer::Dir}[http://mygrid.github.io/ruby-zip-container/3.0.0/ZipContainer/Dir.html] +class which mimics, where possible, the core ruby +{Dir API}[http://ruby-doc.org/core-1.9.3/Dir.html]. + +There are some examples of how to use the library provided in the examples +directory. See the contents of the tests directory for even more. == What this library can not do yet The basic requirements of a UCF document are all implemented but there are a number of optional features that are not yet provided.