Skip to content

Commit

Permalink
DOCS: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Dominic-Marcelino committed Nov 8, 2024
1 parent 550e9ab commit 43f997c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
# 🐰 Directus extension: Auto generate file transformations
> 💡 Automatically generate your file transformations on upload. You can select which transformations should be created based on their key.
> 💡 Automatically generate your file transformations on file upload. You can select which transformations should be created.
![](https://raw.githubusercontent.com/utomic-media/directus-extension-auto-generate-file-transformations/main/docs/Directus-Extension-Auto-Generate-File-Transformations.png)

## ⚙ Settings
Select one or more of the system-transformation-preset. You can also add your custom transformations based on their key.</br>For transformations using 'auto' format (e.g system-transformations)), AVIF versions are generated by this extension (matching Directus' primary format preference for browser-supported formats).
Select one or more of the transformation-preset. The extension will automatically show you all the available system-transformations as well as your own custom transformations. Once you upload or replace a file, the extension will automatically generate all the selected transformations for you.

![](https://raw.githubusercontent.com/utomic-media/directus-extension-auto-generate-file-transformations/main/docs/screenshots/settings.png)

### Memory-consumption
We request the transformations one after another in order to not take to much memory at once. But please still keep in mind that generating all transformations can still be quiet heavy, especially when you upload a lot of image and have a lot of presets selected. We recommend to only select the ones you mostly need.

### Transformation-Presets with 'auto'-format
For transformations using 'auto' format (e.g system-transformations), AVIF versions are generated by this extension. This matches Directus primary format preference (in case avif is supported, directus will prefer avif for auto-formats).

### Deleted Transformation-Presets
Once you delete a custom transformation, it will also be automatically removed from your selection.



## ⚙️ Installation
To install the extension, take a look at the [Official Guide](https://docs.directus.io/extensions/installing-extensions.html).
After installation it will register the required settings-field on the next server-startup.
Expand Down Expand Up @@ -38,3 +49,10 @@ Afterwards this extension can easily be installed through the in-build directus
## ❓ FAQ
### Why should I use this extension?
By default directus will only generate the transformations on first reuquest. In some cases it might be useful to generate the versions directly after upload, for example:
- Your website requires transformations and for max performance you don't want to wait with the generation until a visitor requests them
- You upload a lot of files via API and then, when you visit the Directus Webapp, it takes a lot of time to load the images, as all tranformations still needs to be generated
Binary file modified docs/screenshots/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 43f997c

Please sign in to comment.