README.md in rack-revision-1.0.2 vs README.md in rack-revision-1.1.0

- old
+ new

@@ -1,11 +1,12 @@ # Rack::Revision Rack::Revision is a quick drop-in component to enable code revision tracking. It adds `X-Revision` header with the code revision from capistrano's REVISION file. -[![Build Status](https://travis-ci.org/sosedoff/rack-revision.png?branch=master)](https://travis-ci.org/sosedoff/rack-revision) +[![Build Status](https://img.shields.io/travis/sosedoff/rack-revision.svg)](https://travis-ci.org/sosedoff/rack-revision) +[![Gem Version](https://img.shields.io/gem/v/rack-revision.svg)](http://badge.fury.io/rb/rack-revision) ## Installation Add dependency to your Gemfile: @@ -41,38 +42,48 @@ run Sinatra::Application ``` Available options: -- `:header` - Sets a custom revision header. Default: `X-Revision` -- `:filename` - Sets a filename with revision data. Default: `REVISION` -- `:default` - Sets a revision value if file does not exist. Default: UNDEFINED -- `:rack_env` - Sets a revision value to Rack's `env` hash. Default: `env['rack.app_revision']` +- `:header` - Changes revision header name. Default: `X-Revision` +- `:filename` - Changes the revision filename. Default: `REVISION` +- `:rack_env` - Changes Rack environment key for revision. Default: `env['rack.app_revision']` +- `:env_var` - Sets revision value from an environment variable. Default: `RACK_REVISION` +- `:default` - Sets revision value if env var or a file with revision does not exist. Default: `UNDEFINED` +## Example + +To see what the header might look like, run a curl command: + +``` +curl -i -X HEAD "http://yourdomain.com" +``` + +Example response: + +``` +HTTP/1.1 200 OK +Server: nginx/1.4.4 +Content-Type: text/html; charset=utf-8 +Connection: keep-alive +X-UA-Compatible: IE=Edge,chrome=1 +ETag: "5e622b6dab40d3cb8ad8a4bd51627a59" +Cache-Control: max-age=0, private, must-revalidate +X-Request-Id: ae07ad30bd857788bebfa1421576f96e +X-Runtime: 0.022007 +X-Rack-Cache: miss +X-Revision: a3de2043d4cea6182e511c9c73f57f4f1e0dbc2b +``` + ## Test Execute test suite: ``` rake test ``` ## License -Copyright (c) 2012-2013 Dan Sosedoff. +The MIT License -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +Copyright (c) 2012-2020 Dan Sosedoff <dan.sosedoff@gmail.com> \ No newline at end of file