Document Rack::Deflater

1 files changed, 12 insertions, 0 deletions

diff --git a/lib/rack/deflater.rb b/lib/rack/deflater.rb
index 9972e63d..2f219f0e 100644
--- a/lib/rack/deflater.rb
+++ b/lib/rack/deflater.rb
@@ -4,6 +4,18 @@ require "time"  # for Time.httpdate
 require 'rack/utils'
 
 module Rack
+  # This middleware enables compression of http responses.
+  #
+  # Currently supported compression algorithms:
+  #
+  #   * gzip
+  #   * deflate
+  #   * identity (no transformation)
+  #
+  # The middleware automatically detects when compression is supported
+  # and allowed. For example no transformation is made when a cache
+  # directive of 'no-transform' is present, or when the response status
+  # code is one that doesn't allow an entity body.
   class Deflater
     def initialize(app)
       @app = app