+
+ 
](https://spatie.be/github-ad-click/laravel-translatable)
-Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
-## Upgrading
+We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
-### From v2 to v3
+## Documentation
-In most cases you can upgrade without making any changes to your codebase at all. `v3` introduced a `translations` accessor on your models. If you already had one defined on your model, you'll need to rename it.
+All documentation is available [on our documentation site](https://spatie.be/docs/laravel-translatable).
## Testing
@@ -209,17 +104,17 @@ composer test
## Contributing
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
-If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.
+If you've found a bug regarding security please mail [security@spatie.be](mailto:security@spatie.be) instead of using the issue tracker.
## Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
-Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
+Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards [on our company website](https://spatie.be/en/opensource/postcards).
@@ -231,12 +126,9 @@ We publish all received postcards [on our company website](https://spatie.be/en/
We got the idea to store translations as json in a column from [Mohamed Said](https://github.com/themsaid). Parts of the readme of [his multilingual package](https://github.com/themsaid/laravel-multilingual) were used in this readme.
-## Support us
-
-Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
+## Alternatives
-Does your business depend on our contributions? Reach out and support us on [Patreon](https://www.patreon.com/spatie).
-All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
+- [DB-Fields-Translations](https://github.com/Afzaal565/DB-Fields-Translations)
## License
diff --git a/composer.json b/composer.json
index d21e632..79bf8cc 100644
--- a/composer.json
+++ b/composer.json
@@ -24,21 +24,19 @@
"email": "sebastian@spatie.be",
"homepage": "https://spatie.be/",
"role": "Developer"
- },
- {
- "name": "Mohamed Said",
- "email": "theMohamedSaid@gmail.com",
- "role": "Original idea"
}
],
"require": {
- "php" : "^7.2",
- "laravel/framework": "~5.8.0"
+ "php": "^8.0",
+ "illuminate/database": "^10.0|^11.0|^12.0",
+ "illuminate/support": "^10.0|^11.0|^12.0",
+ "spatie/laravel-package-tools": "^1.11"
},
"require-dev": {
- "phpunit/phpunit": "^8.0",
- "orchestra/testbench": "~3.8.0",
- "mockery/mockery": "^1.0"
+ "friendsofphp/php-cs-fixer": "^3.64",
+ "mockery/mockery": "^1.4",
+ "orchestra/testbench": "^7.0|^8.0|^9.0|^10.0",
+ "pestphp/pest": "^1.20|^2.0|^3.0"
},
"autoload": {
"psr-4": {
@@ -51,9 +49,25 @@
}
},
"scripts": {
- "test": "vendor/bin/phpunit"
+ "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes",
+ "test": "vendor/bin/pest"
},
"config": {
+ "allow-plugins": {
+ "pestphp/pest-plugin": true
+ },
"sort-packages": true
- }
+ },
+ "extra": {
+ "laravel": {
+ "providers": [
+ "Spatie\\Translatable\\TranslatableServiceProvider"
+ ]
+ },
+ "aliases": {
+ "Translatable": "Spatie\\Translatable\\Facades\\Translatable"
+ }
+ },
+ "minimum-stability": "dev",
+ "prefer-stable": true
}
diff --git a/docs/_index.md b/docs/_index.md
new file mode 100644
index 0000000..e08acf5
--- /dev/null
+++ b/docs/_index.md
@@ -0,0 +1,6 @@
+---
+title: v6
+slogan: Translatable Eloquent Models
+githubUrl: https://github.com/spatie/laravel-translatable
+branch: main
+---
diff --git a/docs/about-us.md b/docs/about-us.md
new file mode 100644
index 0000000..4589e99
--- /dev/null
+++ b/docs/about-us.md
@@ -0,0 +1,10 @@
+---
+title: About us
+---
+
+[Spatie](https://spatie.be) is a webdesign agency based in Antwerp, Belgium.
+
+Open source software is used in all projects we deliver. Laravel, Nginx, Ubuntu are just a few
+of the free pieces of software we use every single day. For this, we are very grateful.
+When we feel we have solved a problem in a way that can help other developers,
+we release our code as open source software [on GitHub](https://spatie.be/open-source).
diff --git a/docs/advanced-usage/_index.md b/docs/advanced-usage/_index.md
new file mode 100644
index 0000000..8395637
--- /dev/null
+++ b/docs/advanced-usage/_index.md
@@ -0,0 +1,6 @@
+---
+title: Advanced usage
+weight: 2
+---
+
+
diff --git a/docs/advanced-usage/available-events.md b/docs/advanced-usage/available-events.md
new file mode 100644
index 0000000..3dc0839
--- /dev/null
+++ b/docs/advanced-usage/available-events.md
@@ -0,0 +1,25 @@
+---
+title: Available events
+weight: 1
+---
+
+Right after calling `setTranslation` the `Spatie\Translatable\Events\TranslationHasBeenSetEvent`-event will be fired.
+
+This is how that event looks like:
+
+```php
+namespace Spatie\Translatable\Events;
+
+class TranslationHasBeenSetEvent
+{
+ public function __construct(
+ public mixed $model,
+ public string $key,
+ public string $locale,
+ public mixed $oldValue,
+ public mixed $newValue,
+ ) {
+ //
+ }
+}
+```
diff --git a/docs/advanced-usage/customize-the-toarray-method.md b/docs/advanced-usage/customize-the-toarray-method.md
new file mode 100644
index 0000000..16fafea
--- /dev/null
+++ b/docs/advanced-usage/customize-the-toarray-method.md
@@ -0,0 +1,31 @@
+---
+title: Customize the toArray method
+weight: 1
+---
+
+In many cases, the `toArray()` method on `Model` the class is called under the hood to serialize your model.
+
+To customize for all your models what should get returned for the translatable attributes you could wrap the`Spatie\Translatable\HasTranslations` trait into a custom trait and overrides the `toArray()` method.
+
+```php
+namespace App\Traits;
+use Spatie\Translatable\HasTranslations as BaseHasTranslations;
+
+trait HasTranslations
+{
+ use BaseHasTranslations;
+
+ public function toArray()
+ {
+ $attributes = $this->attributesToArray(); // attributes selected by the query
+ // remove attributes if they are not selected
+ $translatables = array_filter($this->getTranslatableAttributes(), function ($key) use ($attributes) {
+ return array_key_exists($key, $attributes);
+ });
+ foreach ($translatables as $field) {
+ $attributes[$field] = $this->getTranslation($field, \App::getLocale());
+ }
+ return array_merge($attributes, $this->relationsToArray());
+ }
+}
+```
diff --git a/docs/advanced-usage/usage-with-factories.md b/docs/advanced-usage/usage-with-factories.md
new file mode 100644
index 0000000..308a72b
--- /dev/null
+++ b/docs/advanced-usage/usage-with-factories.md
@@ -0,0 +1,41 @@
+---
+title: Usage with factories
+weight: 1
+---
+
+A small helper for making translations has been added for use in factories:
+
+This is what a few possible usages look like:
+
+```php
+/** @var $this \Illuminate\Database\Eloquent\Factories\Factory */
+
+$this->translations('en', 'english')
+// output: ['en' => 'english']
+
+$this->translations(['en', 'nl'], 'english')
+// output: ['en' => 'english', 'nl' => 'english']
+
+$this->translations(['en', 'nl'], ['english', 'dutch'])
+// output: ['en' => 'english', 'nl' => 'dutch']
+```
+
+The helper can also be used outside of factories using the following syntax:
+
+```php
+\Illuminate\Database\Eloquent\Factories\Factory::translations('en', 'english');
+// output: ['en' => 'english']
+```
+
+## In a Factory
+
+```php
+class UserFactory extends \Illuminate\Database\Eloquent\Factories\Factory {
+ public function definition(): array
+ {
+ return [
+ 'bio' => $this->translations('en', 'english'),
+ ];
+ }
+}
+```
diff --git a/docs/basic-usage/_index.md b/docs/basic-usage/_index.md
new file mode 100644
index 0000000..8885cab
--- /dev/null
+++ b/docs/basic-usage/_index.md
@@ -0,0 +1,6 @@
+---
+title: Basic usage
+weight: 1
+---
+
+
diff --git a/docs/basic-usage/getting-and-settings-translations.md b/docs/basic-usage/getting-and-settings-translations.md
new file mode 100644
index 0000000..b352f3d
--- /dev/null
+++ b/docs/basic-usage/getting-and-settings-translations.md
@@ -0,0 +1,123 @@
+---
+title: Getting and setting translations
+weight: 1
+---
+
+First, you must prepare your model as instructed in [the installation instructions](/docs/laravel-translatable/v6/installation-setup).
+
+## Setting a translation
+
+The easiest way to set a translation for the current locale is to just set the property for a translatable attribute.
+
+Here's an example, given that `name` is a translatable attribute:
+
+```php
+$newsItem->name = 'New translation';
+```
+
+To actually save the translation, don't forget to save your model.
+
+```php
+$newsItem->name = 'New translation'
+$newsItem->save();
+```
+
+You can immediately set translations when creating a model.
+
+```php
+NewsItem::create([
+ 'name' => [
+ 'en' => 'Name in English',
+ 'nl' => 'Naam in het Nederlands'
+ ],
+]);
+```
+
+To set a translation for a specific locale you can use this method:
+
+```php
+public function setTranslation(string $attributeName, string $locale, string $value)
+```
+
+You can set translations for multiple languages with
+
+```php
+$translations = ['en' => 'hello', 'es' => 'hola'];
+$newItem->name = $translations;
+
+// alternatively, use the `setTranslations` method
+
+$newsItem->setTranslations('name', $translations);
+
+$newItem->save();
+```
+
+## Getting a translation
+
+The easiest way to get a translation for the current locale is to just get the property for the translated attribute.
+For example (given that `name` is a translatable attribute):
+
+```php
+$newsItem->name;
+```
+
+You can also use this method:
+
+```php
+public function getTranslation(string $attributeName, string $locale, bool $useFallbackLocale = true) : string
+```
+
+This function has an alias named `translate`.
+
+
+### Getting all translations
+
+You can get all translations by calling `getTranslations()` without an argument:
+
+```php
+$newsItem->getTranslations();
+```
+
+Or you can use the accessor:
+
+```php
+$yourModel->translations
+```
+
+The methods above will give you back an array that holds all translations, for example:
+
+```php
+$newsItem->getTranslations('name');
+// returns ['en' => 'Name in English', 'nl' => 'Naam in het Nederlands']
+```
+
+The method above returns, all locales. If you only want specific locales, pass that to the second argument of `getTranslations`.
+
+```php
+public function getTranslations(string $attributeName, array $allowedLocales): array
+```
+
+Here's an example:
+
+```php
+$translations = [
+ 'en' => 'Hello',
+ 'fr' => 'Bonjour',
+ 'de' => 'Hallo',
+];
+
+$newsItem->setTranslations('hello', $translations);
+$newsItem->getTranslations('hello', ['en', 'fr']); // returns ['en' => 'Hello', 'fr' => 'Bonjour']
+```
+
+### Get locales that a model has
+
+You can get all locales that a model has by calling `locales()` without an argument:
+
+```php
+ $translations = ['en' => 'hello', 'es' => 'hola'];
+ $newItem->name = $translations;
+ $newItem->save();
+
+ $newItem->locales(); // returns ['en', 'es']
+```
diff --git a/docs/basic-usage/handling-missing-translations.md b/docs/basic-usage/handling-missing-translations.md
new file mode 100644
index 0000000..127512a
--- /dev/null
+++ b/docs/basic-usage/handling-missing-translations.md
@@ -0,0 +1,141 @@
+---
+title: Handling missing translations
+weight: 7
+---
+
+Sometimes your model doesn't have a requested translation. Using the fallback functionality, you can decide what should
+happen.
+
+To set up fallback you need to call static method on the facade `Spatie\Translatable\Facades\Translatable`. Typically,
+you would put this
+in [a service provider of your own](https://laravel.com/docs/8.x/providers#writing-service-providers):
+
+```php
+ // typically, in a service provider
+
+ use Spatie\Translatable\Facades\Translatable;
+
+ Translatable::fallback(
+ ...
+ );
+```
+
+### Falling back to a specific locale
+
+If you want to have another `fallback_locale` than the app fallback locale (see `config/app.php`), you should pass it
+as `$fallbackLocale` parameter:
+
+```php
+ use Spatie\Translatable\Facades\Translatable;
+
+ Translatable::fallback(
+ fallbackLocale: 'fr',
+ );
+```
+
+### Fallback locale per model
+
+If the fallback locale differs between models, you can define a `getFallbackLocale()` method on your model.
+
+```php
+use Illuminate\Database\Eloquent\Model;
+use Spatie\Translatable\HasTranslations;
+
+class NewsItem extends Model
+{
+ use HasTranslations;
+
+ public $fillable = ['name', 'fallback_locale'];
+
+ public $translatable = ['name'];
+
+ public function getFallbackLocale() : string
+ {
+ return $this->fallback_locale;
+ }
+}
+```
+
+### Falling back to any locale
+
+Sometimes it is favored to return any translation if neither the translation for the preferred locale nor the fallback
+locale are set. To do so, just pass `$fallbackAny` to true:
+
+```php
+ use Spatie\Translatable\Facades\Translatable;
+
+ Translatable::fallback(
+ fallbackAny: true,
+ );
+```
+
+### Customize fallbacks
+
+You can set up a fallback callback that is called when a translation key is missing/not found. It just lets you execute
+some custom code like logging something or contact a remote service for example.
+
+You have to register some code you want to run, by passing a closure to `$missingKeyCallback`.
+
+Here's an example with a closure that logs a warning with some info about the missing translation key:
+
+```php
+use Spatie\Translatable\Facades\Translatable;
+use Illuminate\Support\Facades\Log;
+
+Translatable::fallback(missingKeyCallback: function (
+ Model $model,
+ string $translationKey,
+ string $locale,
+ string $fallbackTranslation,
+ string $fallbackLocale,
+) {
+
+ // do something (ex: logging, alerting, etc)
+
+ Log::warning('Some translation key is missing from an eloquent model', [
+ 'key' => $translationKey,
+ 'locale' => $locale,
+ 'fallback_locale' => $fallbackLocale,
+ 'fallback_translation' => $fallbackTranslation,
+ 'model_id' => $model->id,
+ 'model_class' => get_class($model),
+ ]);
+});
+```
+
+If the closure returns a string, it will be used as the fallback translation:
+
+```php
+use Spatie\Translatable\Facades\Translatable;
+use App\Service\MyRemoteTranslationService;
+
+Translatable::fallback(missingKeyCallback: function (
+ Model $model,
+ string $translationKey,
+ string $locale,
+ string $fallbackTranslation,
+ string $fallbackLocale
+ ) {
+
+ return MyRemoteTranslationService::getAutomaticTranslation($fallbackTranslation, $fallbackLocale, $locale);
+});
+```
+
+### Disabling fallbacks on a per model basis
+By default, a fallback will be used when you access a non-existent translation attribute.
+
+You can disable fallbacks on a model with the `$useFallbackLocale` property.
+
+```php
+use Illuminate\Database\Eloquent\Model;
+use Spatie\Translatable\HasTranslations;
+
+class NewsItem extends Model
+{
+ use HasTranslations;
+
+ public $translatable = ['name'];
+
+ protected $useFallbackLocale = false;
+}
+```
diff --git a/docs/basic-usage/querying-translations.md b/docs/basic-usage/querying-translations.md
new file mode 100644
index 0000000..506d7bf
--- /dev/null
+++ b/docs/basic-usage/querying-translations.md
@@ -0,0 +1,34 @@
+---
+title: Querying translations
+weight: 5
+---
+
+If you're using MySQL 5.7 or above, it's recommended that you use the JSON data type for housing translations in the db.
+This will allow you to query these columns like this:
+
+```php
+NewsItem::where('name->en', 'Name in English')->get();
+```
+
+Or if you're using MariaDB 10.2.3 or above :
+```php
+NewsItem::whereRaw("JSON_EXTRACT(name, '$.en') = 'Name in English'")->get();
+```
+
+If you want to query records based on locales, you can use the `whereLocale` and `whereLocales` methods.
+
+```php
+NewsItem::whereLocale('name', 'en')->get(); // Returns all news items with a name in English
+
+NewsItem::whereLocales('name', ['en', 'nl'])->get(); // Returns all news items with a name in English or Dutch
+```
+
+If you want to query records based on locale's value, you can use the `whereJsonContainsLocale` and `whereJsonContainsLocales` methods.
+
+```php
+// Returns all news items that has name in English with value `Name in English`
+NewsItem::query()->whereJsonContainsLocale('name', 'en', 'Name in English')->get();
+
+// Returns all news items that has name in English or Dutch with value `Name in English`
+NewsItem::query()->whereJsonContainsLocales('name', ['en', 'nl'], 'Name in English')->get();
+```
diff --git a/docs/basic-usage/removing-translations.md b/docs/basic-usage/removing-translations.md
new file mode 100644
index 0000000..d115e81
--- /dev/null
+++ b/docs/basic-usage/removing-translations.md
@@ -0,0 +1,28 @@
+---
+title: Removing translations
+weight: 2
+---
+
+You can forget a translation for a specific field using the `forgetTranslation` function:
+
+```php
+public function forgetTranslation(string $attributeName, string $locale)
+```
+
+Here's an example:
+
+```php
+$newsItem->forgetTranslation('name', 'nl');
+```
+
+You can forget all translations for a specific locale:
+
+```php
+public function forgetAllTranslations(string $locale)
+```
+
+Here's an example:
+
+```php
+$newsItem->forgetAllTranslations('nl');
+```
diff --git a/docs/basic-usage/replacing-translations.md b/docs/basic-usage/replacing-translations.md
new file mode 100644
index 0000000..273e5ed
--- /dev/null
+++ b/docs/basic-usage/replacing-translations.md
@@ -0,0 +1,24 @@
+---
+title: Replacing translations
+weight: 3
+---
+
+You can replace all the translations for a single key using this method:
+
+```php
+public function replaceTranslations(string $key, array $translations)
+```
+
+Here's an example:
+
+```php
+$translations = ['en' => 'hello', 'es' => 'hola'];
+
+$newsItem->setTranslations('hello', $translations);
+$newsItem->getTranslations(); // ['en' => 'hello', 'es' => 'hola']
+
+$newTranslations = ['en' => 'hello'];
+
+$newsItem->replaceTranslations('hello', $newTranslations);
+$newsItem->getTranslations(); // ['en' => 'hello']
+```
diff --git a/docs/basic-usage/validating-translations.md b/docs/basic-usage/validating-translations.md
new file mode 100644
index 0000000..6afd4b6
--- /dev/null
+++ b/docs/basic-usage/validating-translations.md
@@ -0,0 +1,7 @@
+---
+title: Validation translations
+weight: 6
+---
+
+If you want to validate an attribute for uniqueness before saving/updating the db, you might want to have a look at [laravel-unique-translation](https://github.com/codezero-be/laravel-unique-translation) which is made specifically for laravel-translatable.
+
diff --git a/docs/changelog.md b/docs/changelog.md
new file mode 100644
index 0000000..bd03745
--- /dev/null
+++ b/docs/changelog.md
@@ -0,0 +1,6 @@
+---
+title: Changelog
+weight: 6
+---
+
+All notable changes to laravel-translatable are documented [on GitHub](https://github.com/spatie/laravel-translatable/blob/main/CHANGELOG.md)
diff --git a/docs/installation-setup.md b/docs/installation-setup.md
new file mode 100644
index 0000000..92f1b4d
--- /dev/null
+++ b/docs/installation-setup.md
@@ -0,0 +1,31 @@
+---
+title: Installation & setup
+weight: 4
+---
+
+You can install the package via composer:
+
+```bash
+composer require spatie/laravel-translatable
+```
+
+## Making a model translatable
+
+The required steps to make a model translatable are:
+
+- First, you need to add the `Spatie\Translatable\HasTranslations`-trait.
+- Next, you should create a public property `$translatable` which holds an array with all the names of attributes you wish to make translatable.
+- Finally, you should make sure that all translatable attributes are set to the `json`-datatype in your database. If your database doesn't support `json`-columns, use `text`.
+
+Here's an example of a prepared model:
+
+```php
+use Illuminate\Database\Eloquent\Model;
+use Spatie\Translatable\HasTranslations;
+
+class NewsItem extends Model
+{
+ use HasTranslations;
+
+ public array $translatable = ['name'];
+}
diff --git a/docs/introduction.md b/docs/introduction.md
new file mode 100644
index 0000000..0ef0ec9
--- /dev/null
+++ b/docs/introduction.md
@@ -0,0 +1,24 @@
+---
+title: Introduction
+weight: 1
+---
+
+This package contains a trait to make Eloquent models translatable. Translations are stored as json. There is no extra table needed to hold them.
+
+Once the trait is installed on the model you can do these things:
+
+```php
+$newsItem = new NewsItem(); // This is an Eloquent model
+$newsItem
+ ->setTranslation('name', 'en', 'Name in English')
+ ->setTranslation('name', 'nl', 'Naam in het Nederlands')
+ ->save();
+
+$newsItem->name; // Returns 'Name in English' given that the current app locale is 'en'
+$newsItem->getTranslation('name', 'nl'); // returns 'Naam in het Nederlands'
+
+app()->setLocale('nl');
+
+$newsItem->name; // Returns 'Naam in het Nederlands'
+```
+
diff --git a/docs/questions-issues.md b/docs/questions-issues.md
new file mode 100644
index 0000000..bcbfda1
--- /dev/null
+++ b/docs/questions-issues.md
@@ -0,0 +1,8 @@
+---
+title: Questions and issues
+weight: 5
+---
+
+Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving the health library? Feel free to [create an issue on GitHub](https://github.com/spatie/laravel-translatable/issues), we'll try to address it as soon as possible.
+
+If you've found a bug regarding security please mail [freek@spatie.be](mailto:freek@spatie.be) instead of using the issue tracker.
diff --git a/docs/requirements.md b/docs/requirements.md
new file mode 100644
index 0000000..f88dc0e
--- /dev/null
+++ b/docs/requirements.md
@@ -0,0 +1,8 @@
+---
+title: Requirements
+weight: 3
+---
+
+The laravel-translatable package requires **PHP 8.0+**, **Laravel 9+**.
+
+This package uses `json` columns. MySQL 5.7 or higher is required.
diff --git a/docs/support-us.md b/docs/support-us.md
new file mode 100644
index 0000000..90f5c27
--- /dev/null
+++ b/docs/support-us.md
@@ -0,0 +1,8 @@
+---
+title: Support us
+weight: 2
+---
+
+We invest a lot of resources into creating our [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
+
+We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
diff --git a/docs/upgrading.md b/docs/upgrading.md
new file mode 100644
index 0000000..665a6a5
--- /dev/null
+++ b/docs/upgrading.md
@@ -0,0 +1,15 @@
+---
+title: Upgrading
+weight: 3
+---
+
+### From v5 to v6
+
+The config file has been removed. You can now define a fallback locale, set `fallBackAny` and handle custom behaviour for missing translations, via `Translatable::fallback()`. Take a look in the readme to learn how to specify the fallback behaviour you want.
+
+The `TranslationHasBeenSet` event has been renamed to `TranslationHasBeenSetEvent`.
+
+### From v2 to v3
+
+In most cases you can upgrade without making any changes to your codebase at all. `v3` introduced a `translations` accessor on your models. If you already had one defined on your model, you'll need to rename it.
+
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
index bcdc282..bdaf3e7 100644
--- a/phpunit.xml.dist
+++ b/phpunit.xml.dist
@@ -1,25 +1,16 @@
-