Skip to content

Commit 5b1bd2c

Browse files
authored
update README.md
1 parent f0c99aa commit 5b1bd2c

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,22 +62,22 @@ To initialize the Updater class and start the update process, follow these steps
6262
);
6363
```
6464

65-
>- `$username`: Your GitHub username.
66-
>- `$repository`: The name of your GitHub repository.
67-
>- `$token`: The personal access token you generated earlier.
68-
>- `$version`: The generated GitHub personal access token for the repository.
69-
>- `$admin`: (Optional) The email address of the admin who will receive an email in case of update failure.
70-
>- `$mailer`: (Optional) The email address that the email will be sent from.
71-
>- `$exclude`: (Optional) An array of directories or files to exclude from the update. The array keys:<br>&ensp;'path' => an array of excluded paths<br>&ensp;'filename' => an array of excluded filenames
65+
> `$username`: Your GitHub username.<br>
66+
> `$repository`: The name of your GitHub repository.<br>
67+
> `$token`: The personal access token you generated earlier.<br>
68+
> `$version`: The generated GitHub personal access token for the repository.<br>
69+
> `$admin`: (Optional) The email address of the admin who will receive an email in case of update failure.<br>
70+
> `$mailer`: (Optional) The email address that the email will be sent from.<br>
71+
> `$exclude`: (Optional) An array of directories or files to exclude from the update. The array keys:<br>&ensp;'path' => an array of excluded paths<br>&ensp;'filename' => an array of excluded filenames<br>
7272
7373
If a new release is available, the class will update your project automatically.
7474

7575
The class will return the update status with the following possible values:
7676

77-
> `UPDATED`: Indicates that the update was successful.
78-
> `LATEST`: Indicates that the project is already up to date.
79-
> `BUSY`: Indicates that an update process is already in progress.
80-
> `ERROR`: Indicates that the update failed.
77+
> `UPDATED`: Indicates that the update was successful.<br>
78+
> `LATEST`: Indicates that the project is already up to date.<br>
79+
> `BUSY`: Indicates that an update process is already in progress.<br>
80+
> `ERROR`: Indicates that the update failed.<br>
8181
8282
## Conclusion
8383

0 commit comments

Comments
 (0)