Skip to content

Commit 2a56f8a

Browse files
committed
Update readme
1 parent 8ae883c commit 2a56f8a

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
</p>
1010

1111
------
12+
1213
A PHP package to generate Cloudflare Image URLs. based on [Cloudflare Image Resizing](https://developers.cloudflare.com/images/url-format).
1314

1415
> [!IMPORTANT]
@@ -21,6 +22,8 @@ A PHP package to generate Cloudflare Image URLs. based on [Cloudflare Image Resi
2122
composer require aneeskhan47/php-cloudflare-image
2223
```
2324

25+
------
26+
2427
### ❓ How it works
2528

2629
Cloudflare Image Resizing is a feature that allows you to resize, crop, and convert images by simply changing the URL of the image. This is done by adding a set of image transformation parameters to the URL of the image, which Cloudflare will then use to generate a new image on the fly.
@@ -30,6 +33,9 @@ So just by adding `/cdn-cgi/image/` to the beginning of the URL, you can utilize
3033
For more information, please see the [Cloudflare Image Resizing documentation](https://developers.cloudflare.com/images/url-format).
3134

3235
This package provides a fluent API to generate Cloudflare Image Resizing URLs.
36+
37+
------
38+
3339
### 🚀 Usage
3440

3541
```php
@@ -47,6 +53,8 @@ $image = CFImage::make($url)
4753
// https://example.com/cdn-cgi/image/width=300,height=300,format=webp,quality=80/uploads/2023/image.jpg
4854
```
4955

56+
------
57+
5058
### 🧪 Testing
5159

5260
🧹 Keep a modern codebase with **Pint**:
@@ -74,27 +82,39 @@ composer test:unit
7482
composer test
7583
```
7684

85+
------
86+
7787
### 📝 Changelog
7888

7989
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
8090

91+
------
92+
8193
### 🤝 Contributing
8294

8395
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
8496

97+
------
98+
8599
### 🔒 Security
86100

87101
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
88102

103+
------
104+
89105
### 🙌 Credits
90106

91107
- [Anees Khan](https://github.com/aneeskhan47)
92108
- [All Contributors](../../contributors)
93109

110+
------
111+
94112
### 📜 License
95113

96114
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
97115

116+
------
117+
98118
### 🔧 Skeleton PHP Boilerplate
99119

100-
This package was generated using the [Skeleton PHP](https://github.com/nunomaduro/skeleton-php) by **[Nuno Maduro](https://twitter.com/enunomaduro)**.
120+
This package was generated using the [Skeleton PHP](https://github.com/nunomaduro/skeleton-php) by **[Nuno Maduro](https://twitter.com/enunomaduro)**.

0 commit comments

Comments
 (0)