Skip to content

hyperoslo/client_version

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Client Version

Gem Version Build Status Code Climate Coverage Status Join the chat at https://gitter.im/hyperoslo/client-version

When you're building an API, it's really helpful to be able to force your clients to upgrade to the latest version. This is Rack middleware that simply adds a Client-Version header to every response with the value of the CLIENT_VERSION environment variable. Your clients can use it to determine whether they should force the user to upgrade to the latest version.

Installation

You know the drill:

# Gemfile
gem 'client_version'
$ bundle install

Configuration

Set the CLIENT_VERSION environment variable to whatever the latest version of your client is.

If you're using Rails, you're all set; we've hooked into your middleware stack for you. Otherwise just add ClientVersion to your middleware stack.

Hyper loves you

Hyper made this. We're a bunch of folks who love building things. You should tweet us if you can't get it to work. In fact, you should tweet us anyway. If you're using Client Version, we probably want to hire you.

About

Rack middleware for forcing clients to upgrade

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages