CHANGELOG and README

Author: goshasafonov

CHANGELOG.md

@@ -1,7 +1,7 @@
 # Changelog
 
-All notable changes to laravel-package-template will be documented in this file.
+All notable changes to laravel-reactable will be documented in this file.
 
-## 1.0.0 - 2025-02-27
+## 1.0.0 - 2025-10-20
 
-**Full Changelog**: https://github.com/yuges-code/laravel-package-template/commits/1.0.0
+**Full Changelog**: https://github.com/yuges-code/laravel-reactable/commits/1.0.0

README.md

@@ -1,31 +1,31 @@
 <div align="center">
-    <img src="https://raw.githubusercontent.com/yuges-code/laravel-package-template/master/assets/logo.png">
+    <img src="https://raw.githubusercontent.com/yuges-code/laravel-reactable/master/assets/logo.png">
 </div>
 
 <div align="center">
     <b>Build<b>
     <div>
         <img
             alt="GitHub Branch Check Runs"
-            src="https://img.shields.io/github/check-runs/yuges-code/laravel-package-template/main"
+            src="https://img.shields.io/github/check-runs/yuges-code/laravel-reactable/main"
         >
         <img
             alt="GitHub Tests Action Status"
-            src="https://img.shields.io/github/actions/workflow/status/yuges-code/laravel-package-template/testing.yml?branch=main&label=tests&style=flat-square"
+            src="https://img.shields.io/github/actions/workflow/status/yuges-code/laravel-reactable/testing.yml?branch=main&label=tests&style=flat-square"
         >
     </div>
 </div>
 
 <div align="center">
     <b>Project</b>
     <div>
-        <img alt="GitHub Release" src="https://img.shields.io/github/v/release/yuges-code/laravel-package-template">
-        <img alt="Packagist Downloads" src="https://img.shields.io/packagist/dt/yuges-code/laravel-package-template">
-        <img alt="GitHub License" src="https://img.shields.io/github/license/yuges-code/laravel-package-template">
-        <img alt="Packagist Stars" src="https://img.shields.io/packagist/stars/yuges-code/laravel-package-template">
+        <img alt="GitHub Release" src="https://img.shields.io/github/v/release/yuges-code/laravel-reactable">
+        <img alt="Packagist Downloads" src="https://img.shields.io/packagist/dt/yuges-code/laravel-reactable">
+        <img alt="GitHub License" src="https://img.shields.io/github/license/yuges-code/laravel-reactable">
+        <img alt="Packagist Stars" src="https://img.shields.io/packagist/stars/yuges-code/laravel-reactable">
         <img
             alt="Packagist Dependency Version"
-            src="https://img.shields.io/packagist/dependency-v/yuges-code/laravel-package-template/php"
+            src="https://img.shields.io/packagist/dependency-v/yuges-code/laravel-reactable/php"
         >
     </div>
 </div>
@@ -35,36 +35,85 @@
 </div>
 
 <div align="center">
-    <h1>Laravel package template</h1>
+    <h1>Laravel Reactable</h1>
 </div>
 
 <div align="center">
-    <h3>🚀 Starter template for all Yuges Laravel packages</h3>
+    <h3>👍 Package for easily attaching reactions to Laravel eloquent models</h3>
 </div>
 
+<br>
+
 # 💿 Installation
 
-To use this template, clone the repository and install the dependencies:
+### → Composer
+
+You can install the package via composer:
+
+```
+composer require yuges-code/laravel-reactable
+```
+
+### → Publishing Config
+
+Publishing the config file (config/reactable.php) is optional:
+
+```
+php artisan vendor:publish --provider="Yuges\Reactable\Providers\ReactableServiceProvider" --tag="reactable-configs"
+```
+
+### → Publishing Migrations
+
+You need to publish the migration to create the reactions table:
+
+```
+php artisan vendor:publish --provider="Yuges\Reactable\Providers\ReactableServiceProvider" --tag="reactable-migrations"
+```
+
+### → Running Migrations
+
+After that, you need to run migrations:
 
 ```
-git clone https://github.com/yuges-code/laravel-package-template.git
-cd laravel-package-template
+php artisan migrate
+```
+
+### → Publishing Seeders
 
-composer install
+You need to publish the seeder to seed the reaction types table:
+
+```
+php artisan vendor:publish --provider="Yuges\Reactable\Providers\ReactableServiceProvider" --tag="reactable-seeders"
 ```
 
+### → Running Seeders
+
+After that, you need to run seeders:
+
+```
+php artisan db:seed
+```
+
+<br>
+
 # 🧪 Running Tests
 
+### → PHPUnit tests
+
 To run tests, run the following command:
 
 ```
 composer test
 ```
 
+<br>
+
 # ⚖️ License
 
 The MIT License (MIT). Please see [License File](LICENSE) for more information.
 
+<br>
+
 # 🙆🏼‍♂️ Authors Information
 
 Created in 2025 by: