Skip to content

Commit

Permalink
doc: adjust note syntax in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kbond committed Dec 19, 2023
1 parent 2c397d9 commit 8daae28
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ composer require zenstruck/image

## Usage

> **Note**: `Zenstruck\ImageFileInfo` extends `\SplFileInfo`.
> [!NOTE]
> `Zenstruck\ImageFileInfo` extends `\SplFileInfo`.
```php
use Zenstruck\ImageFileInfo;
Expand Down Expand Up @@ -44,7 +45,8 @@ $image->delete(); // void - delete the image file
$image->getMTime();
```

> **Note**: images created with `ImageFileInfo::from()` are created in unique temporary files
> [!NOTE]
> Images created with `ImageFileInfo::from()` are created in unique temporary files
> and deleted at the end of the script.
### Transformations
Expand All @@ -67,7 +69,8 @@ _image object_:
- **imagine\imagine**: `Imagine\Image\ImageInterface`
- **spatie\image**: `Spatie\Image\Image`

> **Note**: The return value of the callable must be the same as the passed parameter.
> [!NOTE]
> The return value of the callable must be the same as the passed parameter.
The following example uses `\GdImage` but any of the above type-hints can be used.

Expand Down

0 comments on commit 8daae28

Please sign in to comment.