summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAustin Ziegler <austin@zieglers.ca>2015-11-22 10:59:10 -0500
committerAustin Ziegler <austin@zieglers.ca>2015-11-22 10:59:10 -0500
commit88304979a95e5fed98e2896613d31cff4174d6fe (patch)
tree36fcff49b1b54da957d35971ea94cdadf1927e10
parent5d68683f0b142767308037135478d639fa9991df (diff)
downloadmime-types-88304979a95e5fed98e2896613d31cff4174d6fe.tar.gz
Updated docs that were missed for 3.0 release
-rw-r--r--Contributing.rdoc45
-rw-r--r--README.rdoc26
2 files changed, 15 insertions, 56 deletions
diff --git a/Contributing.rdoc b/Contributing.rdoc
index efcc91c..3cdffa7 100644
--- a/Contributing.rdoc
+++ b/Contributing.rdoc
@@ -18,48 +18,9 @@ There are a few guidelines for contributing to mime-types:
=== Adding or Modifying MIME Types
-The mime-types registry is loaded from encoded files in +data+. These are not
-editable and cannot be compared meaningfully in a pull request; pull requests
-that include changes to these files will require amendment to revert these
-files.
-
-New or modified MIME types should be edited in the appropriate YAML file under
-+type-lists+. The format is as shown below for the +application/xml+ MIME type
-in +type-lists/application.yml+.
-
- - !ruby/object:MIME::Type
- content-type: application/xml
- encoding: 8bit
- extensions:
- - xml
- - xsl
- xrefs: !ruby/hash:MIME::Types::Container
- rfc:
- - rfc3023
- registered: true
-
-There are other fields that can be added, matching the fields discussed in the
-documentation for MIME::Type. Pull requests for MIME types should just contain
-the changes to the YAML files for the new or modified MIME types; I will
-convert the YAML files to JSON prior to a new release. I would rather not have
-to verify that the JSON matches the YAML changes, which is why it is not
-necessary to convert for the pull request.
-
-If you are making a change for a private fork, use <tt>rake
-convert:yaml:json</tt> to convert the YAML to JSON, or <tt>rake
-convert:yaml:columnar</tt> to convert it to the new columnar format.
-
-==== Updating Types from the IANA or Apache Lists
-
-If you are maintaining a private fork and wish to update your copy of the MIME
-types registry used by this gem, you can do this with the rake tasks:
-
- $ rake mime:iana
- $ rake mime:apache
-
-Both of these require
-{Nokogiri}[http://www.nokogiri.org/tutorials/installing_nokogiri.html], which
-is not installed by default. Install it in the usual way for your Ruby.
+The mime-types registry is no longer contained in mime-types, but in
+{mime-types-data}[https://github.com/mime-types/mime-types-data]. Please see
+that project for contributions there.
=== Test Dependencies
diff --git a/README.rdoc b/README.rdoc
index abf2514..c81ddcf 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -83,8 +83,8 @@ files). A MIME::Type stores the known information about one MIME type.
puts text == 'text/x-plain' # => false
puts 'text/x-plain' == text # => false
- puts MIME::Type.simplified('x-appl/x-zip') # => 'appl/zip'
- puts MIME::Type.i18n_key('x-appl/x-zip') # => 'appl.zip'
+ puts MIME::Type.simplified('x-appl/x-zip') # => 'x-appl/x-zip'
+ puts MIME::Type.i18n_key('x-appl/x-zip') # => 'x-appl.x-zip'
puts text.like?('text/x-plain') # => true
puts text.like?(MIME::Type.new('x-text/x-plain')) # => true
@@ -111,7 +111,7 @@ files). A MIME::Type stores the known information about one MIME type.
xwingz = MIME::Types['application/x-Wingz'].first # => application/x-Wingz
puts xwingz.content_type # => 'application/x-Wingz'
- puts xwingz.simplified # => 'application/wingz'
+ puts xwingz.simplified # => 'application/x-wingz'
=== Columnar Store
@@ -183,19 +183,17 @@ MAJOR.MINOR:
incremented, MINOR will be set to zero, and PATCH will be reset to the
implied zero.
-2. If an API (code) feature is added that does not break compatibilty OR if
- there are MIME types added, removed, or changed in the registry, the MINOR
- version will be incremented and PATCH will be reset to the implied zero.
+2. If an API (code) feature is added that does not break compatibilty, the
+ MINOR version will be incremented and PATCH will be reset to the implied zero.
3. If there is a bugfix to a feature added in the most recent MAJOR.MINOR
- release, OR if purely typographical errors are fixed in MIME types, the
- implied PATCH value will be incremented resulting in MAJOR.MINOR.PATCH.
-
-In practical terms, there should be a MINOR release roughly monthly to track
-updated or changed MIME types from the official IANA registry. This does not
-indicate when new API features have been added, but all minor versions of
-mime-types 2.x will be backwards compatible; the interfaces marked deprecated
-will be removed in mime-types 3.x.
+ release, the implied PATCH value will be incremented resulting in
+ MAJOR.MINOR.PATCH.
+
+In practical terms, there will be fewer releases of mime-types focussing on
+features because of the existence of the [mime-types-data][] gem, and if
+features are marked deprecated in the course of mime-types 3.x, they will not
+be removed until mime-types 4.x or possibly later.
:include: Code-of-Conduct.rdoc