diff --git a/CHANGELOG.md b/CHANGELOG.md index 6e62a33..17c8f41 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,14 +4,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## 1.2.0 -## Fixed -- Support environments with string literals frozen by default. (thanks @danielmorrison) - ## 2.0.0 +## Added +- Response body compression is now streamed. ## Changed - Minimum supported version of Rack is 3.0. +## 1.2.0 +## Fixed +- Support environments with string literals frozen by default. (thanks @danielmorrison) + ## 1.1.0 ## Changed - Removed dependency on `git-version-bump` gem for versioning. `rack-brotli` now only depends on `rack` and `brotli`. diff --git a/README.md b/README.md index 6ce38fc..995974a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Rack::Brotli [![Gem Version](https://badge.fury.io/rb/rack-brotli.svg)](https://badge.fury.io/rb/rack-brotli) [![Build Status](https://travis-ci.org/marcotc/rack-brotli.svg?branch=master)](https://travis-ci.org/marcotc/rack-brotli) +# Rack::Brotli [![Gem Version](https://badge.fury.io/rb/rack-brotli.svg)](https://badge.fury.io/rb/rack-brotli) [![Build Status](https://github.com/marcotc/rack-brotli/actions/workflows/test.yml/badge.svg)](https://github.com/marcotc/rack-brotli/actions/workflows/test.yml) `Rack::Brotli` compresses `Rack` responses using [Google's Brotli](https://github.com/google/brotli) compression algorithm. @@ -17,7 +17,10 @@ Requiring `'rack/brotli'` will autoload `Rack::Brotli` module. The following exa require 'rack' require 'rack/brotli' -use Rack::Brotli +use Rack::Brotli # Default compression quality is 5 + +# You can also provide native Brotli compression options: +# use Rack::Brotli, quality: 11 run theapp ``` @@ -26,10 +29,10 @@ run theapp To run the entire test suite, run - rake test + bundle exec rake test ### Links -* rack-brotli on GitHub:: -* Rack:: -* Rack On GitHub:: +* rack-brotli: +* Brotli for Ruby: +* Rack: diff --git a/rack-brotli.gemspec b/rack-brotli.gemspec index de6c443..5f2a464 100644 --- a/rack-brotli.gemspec +++ b/rack-brotli.gemspec @@ -27,7 +27,7 @@ Gem::Specification.new do |s| s.extra_rdoc_files = %w[README.md COPYING] s.add_runtime_dependency 'rack', '>= 3' - s.add_runtime_dependency 'brotli', '>= 0.3' + s.add_runtime_dependency 'brotli', '>= 0.3' # First version with support for streaming compression through Brotli::Writer s.homepage = "http://github.com/marcotc/rack-brotli/" s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "rack-brotli", "--main", "README"]