Skip to content

Commit e9ef188

Browse files
Update README.md
1 parent b71b953 commit e9ef188

File tree

1 file changed

+32
-7
lines changed

1 file changed

+32
-7
lines changed

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,59 @@ consumers.
2020
2121
## Installation
2222

23-
To get the latest version of **Laravel Feeds**, simply require the project
24-
using [Composer](https://getcomposer.org):
23+
You can install the **Laravel Feeds** package via [Composer](https://getcomposer.org):
2524

2625
```Bash
2726
composer require dragon-code/laravel-feeds
2827
```
2928

30-
After that, publish the configuration file by call the console command:
29+
You should publish
30+
the [migration](database/migrations/2025_09_01_231655_create_feeds_table.php)
31+
and the [config/feeds.php](config/feeds.php) file with:
3132

3233
```bash
33-
php artisan vendor:publish --tag=feeds
34+
php artisan vendor:publish --tag="feeds"
3435
```
3536

37+
> [!WARNING]
38+
>
39+
> Before running migrations, check the database connection settings in the [config/feeds.php](config/feeds.php) file.
40+
41+
Now you can run migrations and proceed to [create feeds](https://feeds.dragon-code.pro/create-feeds.html).
42+
3643
## Basic Usage
3744

3845
### Create Feeds
3946

47+
To create a feed class, use the `make:feed` console command:
48+
4049
```bash
4150
php artisan make:feed User -t
4251
```
4352

4453
As a result of executing the console command, the files `app/Feeds/UserFeed.php` and `app/Feeds/Items/UserFeedItem.php`
4554
will be created.
4655

47-
### Generate Feeds
56+
> [!TIP]
57+
> When creating a feed, an operation/migration will also be created to add it to the database.
58+
>
59+
> If the project uses the [Laravel Deploy Operations](https://deploy-operations.dragon-code.pro), then an operation
60+
> class will be created, otherwise a migration class will be created.
61+
>
62+
> This is necessary to add and manage information about feeds in the database.
63+
64+
Check the [operation/migration](https://feeds.dragon-code.pro/create-feeds.html) file that was created for you and run
65+
the console command:
66+
67+
```bash
68+
# For Laravel Deploy Operations
69+
php artisan operations
70+
71+
# For Laravel Migrations
72+
php artisan migrate
73+
```
4874

49-
To generate feeds, create the classes of feeds and its element, add links to the file `config/feeds.php`, next call the
50-
console command:
75+
To generate all active feeds, use the console command:
5176

5277
```bash
5378
php artisan feed:generate

0 commit comments

Comments
 (0)