ReadMe.rdoc in zip-container-1.1.0 vs ReadMe.rdoc in zip-container-2.0.0
- old
+ new
@@ -17,10 +17,21 @@
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.
-== Backwards incompatibility warning!
+== 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).
+
+ZipContainer::Container is unavailable 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
incompatible API that may clash with other gems that you are using. Please see
the {important note}[https://github.com/rubyzip/rubyzip/blob/master/README.md#important-note]