Implement Translatables

.editorconfig

@@ -13,3 +13,6 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.yml]
+indent_size = 2

.github/workflows/run-tests.yml

@@ -1,60 +1,70 @@
 name: tests
 
 on:
-    pull_request:
-        branches:
-            - main
-    push:
-        branches:
-            - main
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+      - dev
 
 jobs:
-    tests:
-        runs-on: ${{ matrix.os }}
-
-        strategy:
-            fail-fast: true
-            matrix:
-                os: [ ubuntu-latest ]
-                php: [ 8.3, 8.2, 8.1 ]
-                laravel: [ 11.*, 10.*, 9.* ]
-                stability: [ prefer-lowest, prefer-stable ]
-                include:
-                    -   laravel: 11.*
-                        testbench: 9.*
-                        carbon: ^2.63
-                    -   laravel: 10.*
-                        testbench: 8.*
-                        carbon: ^2.63
-                    -   laravel: 9.*
-                        testbench: 7.*
-                        carbon: ^2.63
-                exclude:
-                    -   laravel: 11.*
-                        php: 8.1
-
-        name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
-
-        steps:
-            -   name: Checkout code
-                uses: actions/checkout@v4
-
-            -   name: Install SQLite 3
-                run: |
-                    sudo apt-get update
-                    sudo apt-get install sqlite3 -y
-
-            -   name: Setup PHP
-                uses: shivammathur/setup-php@v2
-                with:
-                    php-version: ${{ matrix.php }}
-                    extensions: curl, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, iconv
-                    coverage: none\
-
-            -   name: Install dependencies
-                run: |
-                    composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" "nesbot/carbon:${{ matrix.carbon }}" --no-interaction --no-update
-                    composer update --${{ matrix.stability }} --prefer-dist --no-interaction
-
-            -   name: Execute tests
-                run: vendor/bin/phpunit
+  tests:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ ubuntu-latest ]
+        php: [ 8.3, 8.2, 8.1 ]
+        laravel: [ 11.*, 10.*, 9.* ]
+        stability: [ prefer-lowest, prefer-stable ]
+        include:
+          - laravel: 11.*
+            testbench: 9.*
+            carbon: ^2.63
+          - laravel: 10.*
+            testbench: 8.*
+            carbon: ^2.63
+          - laravel: 9.*
+            testbench: 7.*
+            carbon: ^2.63
+        exclude:
+          - laravel: 11.*
+            php: 8.1
+
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install SQLite 3
+        run: |
+          sudo apt-get update
+          sudo apt-get install sqlite3 -y
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: curl, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, iconv
+          coverage: ${{ startsWith(github.event.head_commit.message, 'coverage') && matrix.php == '8.3' && matrix.laravel == '11.*' && matrix.stability == 'prefer-stable' && 'xdebug' || 'none' }}
+
+      - name: Install dependencies
+        run: |
+          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" "nesbot/carbon:${{ matrix.carbon }}" --no-interaction --no-update
+          composer update --${{ matrix.stability }} --prefer-dist --no-interaction
+
+      - name: Execute tests
+        run: |
+          vendor/bin/phpunit ${{ startsWith(github.event.head_commit.message, 'coverage') && matrix.php == '8.3' && matrix.laravel == '11.*' && matrix.stability == 'prefer-stable' && '--coverage-clover=clover.xml' || '' }}
+
+      - name: Make code coverage badge
+        if: startsWith(github.event.head_commit.message, 'coverage') && matrix.php == '8.3' && matrix.laravel == '11.*' && matrix.stability == 'prefer-stable'
+        uses: timkrase/phpunit-coverage-badge@v1.2.1
+        with:
+          coverage_badge_path: .github/coverage.svg
+          push_badge: true
+          repo_token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -3,12 +3,59 @@
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/javaabu/translatable.svg?style=flat-square)](https://packagist.org/packages/javaabu/translatable)
 [![Test Status](../../actions/workflows/run-tests.yml/badge.svg)](../../actions/workflows/run-tests.yml)
 [![Total Downloads](https://img.shields.io/packagist/dt/javaabu/translatable.svg?style=flat-square)](https://packagist.org/packages/javaabu/translatable)
-
+![Code Coverage](./.github/coverage.svg)
 
 
 ## Introduction
+
 Adds multi-lingual to Laravel models
 
+To get started with this package, you can simply add `DbTranslatableSchema::columns($table);` or `JsonTranslatableSchema::columns($table);` to your migration `up` function.
+
+```php
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+use Javaabu\Translatable\DbTranslatable\DbTranslatableSchema;
+
+return new class extends Migration {
+    public function up(): void
+    {
+        Schema::create('posts', function (Blueprint $table) {
+            $table->id();
+
+            ...
+
+            DbTranslatableSchema::columns($table);
+        });
+    }
+
+    public function down(): void
+    {
+        Schema::dropIfExists('posts');
+    }
+};
+```
+
+And then all you need to do is add the `Translatable` implementation using the `IsDbTranslatable` or `IsJsonTranslatable` trait.
+
+```php
+...
+
+class Post extends Model implements Translatable
+{
+    use IsDbTranslatable;
+
+...
+```
+
+Now, your models will automatically be translated according to the current `app()->getLocale()`. To add different translations, all you need to do is
+
+```php
+// to add title for dv language
+$post->title_dv = "Mee Dhivehi title eh";
+```
+
 ## Documentation
 
 You'll find the documentation on [https://docs.javaabu.com/docs/translatable](https://docs.javaabu.com/docs/translatable).
@@ -43,6 +90,7 @@ If you discover any security related issues, please email [info@javaabu.com](mai
 - [Javaabu Pvt. Ltd.](https://github.com/javaabu)
 - [Arushad Ahmed (@dash8x)](http://arushad.com)
 - [Xylam (@Xylam)](https://github.com/Xylam)
+- [FlameXode (@WovenCoast)](https://github.com/WovenCoast)
 - [All Contributors](../../contributors)
 
 ## License