Skip to content

Commit 3934a3d

Browse files
committed
Improve README for 2.0
1 parent a672aec commit 3934a3d

1 file changed

Lines changed: 18 additions & 7 deletions

File tree

README.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,31 @@ This is the Internationalization project for [Solidus](https://solidus.io)
88

99
---
1010

11-
## Supported languages
11+
## Changes in Version 2.0
1212

13-
We currently support the [following locales](https://github.com/solidusio-contrib/solidus_i18n/tree/master/config/locales)
14-
by default. If you need a locale that is not in the list you can add a custom
15-
translation file into your application by following the
16-
[Rails translations guide](http://guides.rubyonrails.org/i18n.html#how-to-store-your-custom-translations).
13+
solidus_i18n Version 2.0+ only contains translation files.
14+
15+
Previous versions of solidus_i18n included extra functionality like locale
16+
selectors and which is now built in to Solidus 2.6+. Configuration for
17+
`routing-fitler` has also been removed and must be configured manually
18+
(See [Locale in URL](#locale-in-url)).
1719

1820
## Installation
1921

2022
Add the following to your `Gemfile`:
2123

2224
```ruby
2325
gem 'solidus_i18n', '~> 2.0'
26+
gem 'rails-i18n', '~> 5.1'
27+
gem 'kaminari-i18n', '~> 0.5.0'
2428
```
2529

2630
## Locale in URL
2731

2832
Older versions of solidus_i18n included the routing-filter gem and configured routes to include the locale in the URL.
2933
This is still supported (maybe even recommended) but requires some additional configuration.
3034

31-
1. Add gem to your `Gemfile`, then run `bundle install`
35+
1. Add this gem to your `Gemfile`, then run `bundle install`
3236

3337
``` ruby
3438
gem 'routing-filter', '~> 0.6.0'
@@ -44,13 +48,20 @@ Rails.application.routes.draw do
4448
end
4549
```
4650

47-
3. Configure locale-fitler in `config/initializers/locale_filter.rb` (optional)
51+
3. Configure routing-fitler in `config/initializers/locale_filter.rb` (optional)
4852

4953
``` ruby
5054
# Do not include the default locale in the URL
5155
RoutingFilter::Locale.include_default_locale = false
5256
```
5357

58+
## Supported languages
59+
60+
We currently support the [following locales](https://github.com/solidusio-contrib/solidus_i18n/tree/master/config/locales)
61+
by default. If you need a locale that is not in the list you can add a custom
62+
translation file into your application by following the
63+
[Rails translations guide](http://guides.rubyonrails.org/i18n.html#how-to-store-your-custom-translations).
64+
5465
## Updating Translations
5566

5667
If you want to improve the translations on your language, run the tasks:

0 commit comments

Comments
 (0)