ReadMe.rdoc in zip-container-2.0.0 vs ReadMe.rdoc in zip-container-2.1.0

- old
+ new

@@ -17,19 +17,25 @@ This is a Ruby library for working with ZIP Container files. See the {ODF}[http://www.idpf.org/epub/30/spec/epub30-ocf.html] and {UDF}[https://learn.adobe.com/wiki/display/PDFNAV/Universal+Container+Format] specifications for more details. +We follow the principles of {Semantic Versioning}[http://semver.org/] for our +releases. + == Backwards incompatibility warnings! === ZipContainer -The ZipContainer::Container class is deprecated in favour of -ZipContainer::File. These classes are functionally identical; it is just a -change of name. The new name brings this API into closer alignment with the -underlying rubyzip API (Zip::File). +The ZipContainer::Container class is now a common superclass of +ZipContainer::Dir and ZipContainer::File. You can use ZipContainer::File as a +direct replacement for ZipContainer::Container as the functionality is +preserved. The new names bring this API into closer alignment with the +underlying rubyzip API (Zip::File) and allows this library to work with +"exploded" or unpacked containers directly. -ZipContainer::Container is unavailable from version 2.0.0 onwards. +ZipContainer::Container should not be used directly from version 2.0.0 +onwards. === Rubyzip Version 1.0.0 and up of this gem uses version 1.0.0 and up of the {rubyzip}[https://rubygems.org/gems/rubyzip] library. This has a backwards