README with syntax highlighting (svenfuchs#113)

Author: dorianmariecom

README.md

@@ -0,0 +1,97 @@
+# I18n::Backend::ActiveRecord
+
+This repository contains the I18n ActiveRecord backend and support code that has been extracted from the "I18n": https://github.com/svenfuchs/i18n.
+It is fully compatible with Rails 3, 4, 5 and 6.
+
+## Installation
+
+For Bundler put the following in your Gemfile:
+
+```ruby
+gem 'i18n-active_record', require: 'i18n/active_record'
+```
+
+After updating your bundle, run the installer
+
+    $ rails g i18n:active_record:install
+
+It creates a migration:
+
+```ruby
+class CreateTranslations < ActiveRecord::Migration
+  def change
+    create_table :translations do |t|
+      t.string :locale
+      t.string :key
+      t.text :value
+      t.text :interpolations
+      t.boolean :is_proc, default: false
+
+      t.timestamps
+    end
+  end
+end
+```
+
+To specify table name use:
+
+    $ rails g i18n:active_record:install MyTranslation
+
+With the translation model you will be able to manage your translation, and add new translations or languages through
+it.
+
+By default the installer creates a new file in `config/initializers` named `i18n_active_record.rb` with the following content.
+
+```ruby
+require 'i18n/backend/active_record'
+
+Translation  = I18n::Backend::ActiveRecord::Translation
+
+if Translation.table_exists?
+  I18n.backend = I18n::Backend::ActiveRecord.new
+
+  I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Memoize)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Memoize)
+  I18n::Backend::Simple.send(:include, I18n::Backend::Pluralization)
+
+  I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Simple.new, I18n.backend)
+end
+```
+
+To perform a simpler installation use:
+
+    $ rails g i18n:active_record:install --simple
+
+It generates:
+
+```ruby
+require 'i18n/backend/active_record'
+I18n.backend = I18n::Backend::ActiveRecord.new
+```
+
+You may also configure whether the ActiveRecord backend should use `destroy` or `delete` when cleaning up internally.
+
+```ruby
+I18n::Backend::ActiveRecord.configure do |config|
+  config.cleanup_with_destroy = true # defaults to false
+end
+```
+
+## Usage
+
+You can now use `I18n.t('Your String')` to lookup translations in the database.
+
+## Missing Translations -> Interpolations
+
+The `interpolations` field in the `translations` table is used by `I18n::Backend::ActiveRecord::Missing` to store the interpolations seen the first time this Translation was requested.  This will help translators understand what interpolations to expect, and thus to include when providing the translations.
+
+The `interpolations` field is otherwise unused since the "value" in `Translation#value` is actually used for interpolation during actual translations.
+
+## Examples
+
+* http://collectiveidea.com/blog/archives/2016/05/31/beyond-yml-files-dynamic-translations/
+
+## Maintainers
+
+* Sven Fuchs
+* Tim Masliuchenko