Skip to content

Commit 13729bf

Browse files
committed
feat: add boost guidelines
1 parent ed700cb commit 13729bf

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Laravel Image Transform URL
2+
3+
- Laravel Image Transform URL is a Laravel package for transforming images on-the-fly via URL parameters, similar to Cloudflare Images.
4+
- Laravel Image Transform URL supports multiple transformation drivers, S3 storage, automatic caching, CDN integration and more.
5+
- The available transformation options and their parameters can be found in the documentation linked below.
6+
- Always use the `ImageTransformUrl` facade to generate URLs for transformed images.
7+
- Laravel Image Transform URL documentation follows the `llms.txt` format for its docs website, hosted at `https://image-transform-url.julian.center/**`
8+
- **Before implementing any features using Laravel Image Transform URL, use the `web-search` tool when available to get the latest docs for a specific feature. The available docs are listed in <available-docs>**
9+
10+
### Basic Usage Patterns
11+
- Use the `ImageTransformUrl::make($path, $options, ?$pathPrefix)` method to create a URL for an image with transformations.
12+
- Use the `ImageTransformUrl::signedUrl($path, $options, ?$pathPrefix)` or `ImageTransformUrl::temporarySignedUrl($path, $options, $expiration, ?$pathPrefix)` method to create a signed URL for an image with transformations.
13+
- You may also create URLs manually by following the following URL structure: `http(s)://<domain>/<route-prefix>/<source-directory>/<options>/<image-path>`
14+
15+
<available-docs>
16+
## Basics
17+
- [**/installation.md] Installation Guide
18+
- [**/setup.md] Package Setup and Configuration
19+
- [**/getting-started.md] Basic Usage and Examples
20+
21+
## Options
22+
- [**/configuring-options.md] Configuring Available Transformation Options
23+
- [**/available-options.md] List of Available Transformation Options and Parameters
24+
25+
## Advanced
26+
- [**/signed-urls.md] Setup and Usage of Signed URLs
27+
- [**/image-caching.md] Image Caching Strategies and Configuration
28+
- [**/rate-limiting.md] Rate Limiting for Image Requests
29+
- [**/s3-usage.md] Using Amazon S3 Compatible Storage
30+
- [**/cdn-usage.md] Usage with CDNs
31+
- [**/error-handling.md] Error Handling and Fallbacks
32+
</available-docs>

0 commit comments

Comments
 (0)