Contents

= rails_locale_detection

Sets the current locale of a request using a combination of params, cookies, and http headers. 

In turn, it checks the value of params[:locale], cookies[:locale] and finally HTTP_ACCEPT_LANGUAGE headers to find a locale that
corresponds to the available locales, then stores the set locale in a cookie for future requests.

== Usage

Include the gem in your Gemfile 

  gem 'rails_locale_detection'
  
Set your default and available locales

  I18n.default_locale = :en
  I18n.available_locales = [:en, :fr]
  
Call set_locale as a filter in your controllers

  class ApplicationController < ActionController::Base
    before_filter :set_locale
    
  end

== Configuration

There are two configuration options:

  Rails::LocaleDetection.config do |config|
    config.locale_expiry = 3.months # This sets how long the locale cookie lasts.
    config.set_default_url_option = true # sets the default_url_options[:locale] to the current locale when set_locale is called
  end

== Contributing to rails_locale_detection
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Copyright

Copyright (c) 2012 Mateo Murphy. See LICENSE.txt for
further details.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rails_locale_detection-1.1.0	README.rdoc