Skip to content

Commit 5840688

Browse files
committed
update README
1 parent 909da0b commit 5840688

File tree

1 file changed

+47
-14
lines changed

1 file changed

+47
-14
lines changed

README.md

Lines changed: 47 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
<div align="center">
2-
<img src="https://raw.githubusercontent.com/yuges-code/laravel-package-template/master/assets/logo.png">
2+
<img src="https://raw.githubusercontent.com/yuges-code/laravel-mediable/master/assets/logo.png">
33
</div>
44

55
<div align="center">
66
<b>Build<b>
77
<div>
88
<img
99
alt="GitHub Branch Check Runs"
10-
src="https://img.shields.io/github/check-runs/yuges-code/laravel-package-template/main"
10+
src="https://img.shields.io/github/check-runs/yuges-code/laravel-mediable/main"
1111
>
1212
<img
1313
alt="GitHub Tests Action Status"
14-
src="https://img.shields.io/github/actions/workflow/status/yuges-code/laravel-package-template/testing.yml?branch=main&label=tests&style=flat-square"
14+
src="https://img.shields.io/github/actions/workflow/status/yuges-code/laravel-mediable/testing.yml?branch=main&label=tests&style=flat-square"
1515
>
1616
</div>
1717
</div>
1818

1919
<div align="center">
2020
<b>Project</b>
2121
<div>
22-
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/yuges-code/laravel-package-template">
23-
<img alt="Packagist Downloads" src="https://img.shields.io/packagist/dt/yuges-code/laravel-package-template">
24-
<img alt="GitHub License" src="https://img.shields.io/github/license/yuges-code/laravel-package-template">
25-
<img alt="Packagist Stars" src="https://img.shields.io/packagist/stars/yuges-code/laravel-package-template">
22+
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/yuges-code/laravel-mediable">
23+
<img alt="Packagist Downloads" src="https://img.shields.io/packagist/dt/yuges-code/laravel-mediable">
24+
<img alt="GitHub License" src="https://img.shields.io/github/license/yuges-code/laravel-mediable">
25+
<img alt="Packagist Stars" src="https://img.shields.io/packagist/stars/yuges-code/laravel-mediable">
2626
<img
2727
alt="Packagist Dependency Version"
28-
src="https://img.shields.io/packagist/dependency-v/yuges-code/laravel-package-template/php"
28+
src="https://img.shields.io/packagist/dependency-v/yuges-code/laravel-mediable/php"
2929
>
3030
</div>
3131
</div>
@@ -35,36 +35,69 @@
3535
</div>
3636

3737
<div align="center">
38-
<h1>Laravel package template</h1>
38+
<h1>Laravel Mediable</h1>
3939
</div>
4040

4141
<div align="center">
42-
<h3>🚀 Starter template for all Yuges Laravel packages</h3>
42+
<h3>🎴 Package for easily uploading and attaching media files to Laravel eloquent models</h3>
4343
</div>
4444

45+
<br>
46+
4547
# 💿 Installation
4648

47-
To use this template, clone the repository and install the dependencies:
49+
### → Composer
50+
51+
You can install the package via composer:
52+
53+
```
54+
composer require yuges-code/laravel-mediable
55+
```
56+
57+
### → Publishing Config
58+
59+
Publishing the config file (config/mediable.php) is optional:
60+
61+
```
62+
php artisan vendor:publish --provider="Yuges\Mediable\Providers\MediableServiceProvider" --tag="mediable-configs"
63+
```
64+
65+
### → Publishing Migrations
66+
67+
You need to publish the migration to create the groups table:
4868

4969
```
50-
git clone https://github.com/yuges-code/laravel-package-template.git
51-
cd laravel-package-template
70+
php artisan vendor:publish --provider="Yuges\Mediable\Providers\MediableServiceProvider" --tag="mediable-migrations"
71+
```
72+
73+
### → Running Migrations
74+
75+
After that, you need to run migrations:
5276

53-
composer install
5477
```
78+
php artisan migrate
79+
```
80+
81+
<br>
5582

5683
# 🧪 Running Tests
5784

85+
### → PHPUnit tests
86+
5887
To run tests, run the following command:
5988

6089
```
6190
composer test
6291
```
6392

93+
<br>
94+
6495
# ⚖️ License
6596

6697
The MIT License (MIT). Please see [License File](LICENSE) for more information.
6798

99+
<br>
100+
68101
# 🙆🏼‍♂️ Authors Information
69102

70103
Created in 2025 by:

0 commit comments

Comments
 (0)