datocms-plugin-asset-optimization 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,88 @@
1
+ # DatoCMS Asset Optimization Plugin
2
+
3
+ A plugin that allows you to mass apply optimizations to your DatoCMS assets, significantly reducing image file sizes while maintaining visual quality.
4
+
5
+ ![Asset Optimization Plugin Cover](docs/cover-1200x800.png)
6
+
7
+ ## Overview
8
+
9
+ The DatoCMS Asset Optimization Plugin leverages Imgix's powerful image processing capabilities to optimize your media library assets. It helps you:
10
+
11
+ - Reduce image file sizes without sacrificing quality
12
+ - Apply batch optimization to multiple assets
13
+ - Configure quality levels based on asset sizes
14
+ - Convert images to modern formats like AVIF or WebP
15
+ - Track optimization progress with detailed logs
16
+ - View statistics on storage savings
17
+
18
+ ## Installation
19
+
20
+ 1. Log in to your DatoCMS project
21
+ 2. Go to Settings > Plugins
22
+ 3. Search for "Asset Optimization"
23
+ 4. Click "Install"
24
+ 5. Configure the plugin settings as desired
25
+
26
+ ## Usage
27
+
28
+ 1. After installation, navigate to the plugin in your DatoCMS dashboard
29
+ 2. Configure the optimization settings according to your needs
30
+ 3. Click "Start Optimization" to begin the process
31
+ 4. Watch the progress as the plugin processes your assets
32
+ 5. View the results including statistics on size savings
33
+
34
+ ### Asset Filtering & Optimization
35
+
36
+ - **Size-Based Filtering**: Only process assets above a certain size threshold
37
+ - **Intelligent Optimization**: Apply different optimization strategies based on asset size categories
38
+ - **Format Conversion**: Convert images to modern formats like AVIF for better compression
39
+ - **Dimension Resizing**: Automatically resize oversized images while maintaining aspect ratio
40
+
41
+ ### Website Performance Optimization
42
+
43
+ - Reduce page load times by decreasing image payload sizes
44
+ - Improve Core Web Vitals scores with optimized images
45
+ - Enhance mobile experience with appropriately sized images
46
+
47
+ ### Storage Cost Reduction
48
+
49
+ - Minimize storage usage in your DatoCMS media library
50
+ - Reduce CDN bandwidth consumption
51
+ - Lower operating costs while maintaining quality
52
+
53
+ ### Batch Processing
54
+
55
+ - Mass-update existing media libraries with optimized assets
56
+ - Apply consistent optimization settings across your entire asset collection
57
+ - Save time compared to manual optimization workflows
58
+
59
+ ## Development
60
+
61
+ ### Prerequisites
62
+
63
+ - Node.js (v14+)
64
+ - npm or yarn
65
+ - DatoCMS account with developer access
66
+
67
+ ### Local Development
68
+
69
+ 1. Clone the repository
70
+ 2. Install dependencies: `npm install`
71
+ 3. Start the development server: `npm run dev`
72
+ 4. Configure a local DatoCMS plugin in your project settings pointing to your local server
73
+
74
+ ### Building for Production
75
+
76
+ ```bash
77
+ npm run build
78
+ ```
79
+
80
+ The built files will be in the `dist` directory, ready for deployment.
81
+
82
+ ## Support
83
+
84
+ If you encounter any issues or have questions about the plugin, please [open an issue](https://github.com/marcelofinamorvieira/datocms-plugin-asset-optimization/issues) on GitHub.
85
+
86
+ ## License
87
+
88
+ MIT