Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme #22

Merged
merged 2 commits into from
Jan 22, 2024
Merged

readme #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2f9832
Update PHP versions in run-tests.yml
ewilan-riviere Dec 6, 2023
1dd9108
Update README.md with note and warning messages
ewilan-riviere Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
fail-fast: true
matrix:
os: [ubuntu-latest, windows-latest]
php: [8.2, 8.1]
php: [8.3, 8.2, 8.1]
stability: [prefer-stable]

name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

PHP package to parse and update audio files metadata, with [`JamesHeinrich/getID3`](https://github.com/JamesHeinrich/getID3).

> **Note**
> [!NOTE]
>
> You can check formats supported on [Supported formats](#supported-formats) section.

Expand Down Expand Up @@ -100,7 +100,7 @@ $audio->getCover(); // `?AudioCover` with cover metadata

You can update audio files metadata with `Audio::class`, but not all formats are supported. [See supported formats](#updatable-formats)

> **Warning**
> [!WARNING]
>
> You can use any property of `Audio::class` but if you use a property not supported by the format, it will be ignored.

Expand Down Expand Up @@ -142,7 +142,7 @@ Some properties are not supported by all formats, for example `MP3` can't handle

You can set tags manually with `tags` method, but you need to know the format of the tag, you could use `tagFormats` to set formats of tags (if you don't know the format, it will be automatically detected).

> **Warning**
> [!WARNING]
>
> If you use `tags` method, you have to use key used by metadata container. For example, if you want to set album artist in `id3v2`, you have to use `band` key. If you want to know which key to use check `src/Models/AudioCore.php` file.
>
Expand Down