Skip to content

AlexWayfer/flame-r18n

Repository files navigation

Flame R18n

Flame plugin which provides i18n and L10n support to your web application.

It is a wrapper for R18n core library. See R18n documentation for more information.

Cirrus CI - Base Branch Build Status Codecov branch Code Climate Depfu Inline docs license Gem

Usage

# Gemfile
gem 'flame-r18n'

# config.ru
require 'flame-r18n' # or `Bundler.require`

# For application configuration
# config/processors/r18n.rb
::R18n.default_places = File.join config[:root_dir], 'locales'
::R18n::I18n.default = 'en'

# _controller.rb
include Flame::R18n::Initialization # for loading thread-based locale

# site/_controller.rb
prepend Flame::R18n::LocaleInPath # for mounting controllers at `/:locale`

Development

After checking out the repo, run bundle install to install dependencies.

Then, run toys rspec to run the tests.

To install this gem onto your local machine, run toys gem install.

To release a new version, run toys gem release %version%. See how it works here.

Contributing

Bug reports and pull requests are welcome on GitHub.

License

The gem is available as open source under the terms of the MIT License.