Skip to content

Commit 2b59553

Browse files
Update command and widget naming conventions
1 parent 3c340c6 commit 2b59553

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

README.md

+19-18
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,24 @@ return [
5858

5959
## Usage
6060

61-
### Widgets
61+
### Command
62+
63+
> [!NOTE]
64+
> Make sure you run this command atleast once to store the current composer dependencies.
65+
66+
To run the command to check for outdated composer dependencies, you can run the following command:
67+
68+
```bash
69+
php artisan composer:outdated
70+
```
71+
72+
But obviously, you don't want to run this command manually every time you want to check for outdated dependencies. So, you can use the command in your scheduler to run this command automatically.
73+
74+
```php
75+
Schedule::call(CheckComposerVersions::class)->daily();
76+
```
6277

63-
#### Oudated Composer Dependencies
78+
### DependencyWidget
6479
This widget will display all outdated composer dependencies with the current version and the latest version available.
6580

6681
```php
@@ -69,8 +84,8 @@ This widget will display all outdated composer dependencies with the current ver
6984
])
7085
```
7186

72-
### Stats
73-
Stats widget will display the installed version of the dependencies and the latest version available.
87+
### DependencyStat
88+
Stat widget will display the installed version of the dependencies and the latest version available.
7489

7590
```php
7691
class StatsOverview extends BaseWidget
@@ -85,18 +100,4 @@ class StatsOverview extends BaseWidget
85100
];
86101
}
87102
}
88-
```
89-
90-
### Command
91-
92-
To run the command to check for outdated composer dependencies, you can run the following command:
93-
94-
```bash
95-
php artisan composer:outdated
96-
```
97-
98-
But obviously, you don't want to run this command manually every time you want to check for outdated dependencies. So, you can use the command in your scheduler to run this command automatically.
99-
100-
```php
101-
Schedule::call(CheckComposerVersions::class)->daily();
102103
```

0 commit comments

Comments
 (0)