Merge pull request #16 from 343dev/improvement/internal-stuff

Add license check on pre-push & Update docs

.github/workflows/publish-docker.yml

@@ -40,4 +40,4 @@ jobs:
         with:
           push: true
           platforms: ${{ env.IMAGE_PLATFORMS }}
-          tags: ${{ env.IMAGE_NAME }}:latest,${{ env.IMAGE_NAME }}:${{ env.PKG_VERSION }}
+          tags: ${{ env.IMAGE_NAME }}:${{ env.PKG_VERSION }},${{ env.IMAGE_NAME }}:latest

.github/workflows/publish-npm.yml

@@ -8,8 +8,8 @@ jobs:
   publish_to_npm:
     runs-on: ubuntu-latest
     permissions:
-      actions: write # Fix for “Error: Resource not accessible by integration” by Cancelling step
-      id-token: write # Provenance generation in GitHub Actions requires "write" access to the "id-token" permission
+      actions: write # “andymckay/cancel-action” requires “write” access to the “actions” permission
+      id-token: write # Provenance generation in GitHub Actions requires “write” access to the “id-token” permission
     steps:
       -
         name: Checkout repository

CHANGELOG.md

@@ -12,14 +12,12 @@
 
 ## 9.0.0 (2024-10-03)
 
-Changes:
-
 - Improved image processing workflow. Check the [migration guide](./MIGRATION.md) for details.
 - Added an interactive log for image processing.
 - Changed the “File already exists” message from “error” to “info,” now only shown in verbose mode.
 - Added a notice that animated AVIF is not supported (unfortunately).
 - Fixed the progress indicator in conversion mode. It now correctly shows the total number of items.
-- Fixed output to the user directory. The original folder structure is now preserved (i hope so!).
+- Fixed output to the user directory. The original folder structure is now preserved (I hope so!).
 
 ## 8.0.0 (2024-08-05)
 

MIGRATION.md

@@ -4,11 +4,11 @@
 
 The main change in the new version is how Optimizt handles file processing. Before, the result was stored in memory until all files were processed. This could cause the app to crash if it ran out of memory, leading to a loss of optimization results. Now, each file is processed one by one, and the result is saved to disk immediately. Logging events also happen in real-time, instead of waiting until all files are done.
 
-Previously, if you tried to create an AVIF or WebP file that already existed, an error message would appear in the log. Now, it shows an informational message, but only if you use the --verbose option.
+Previously, if you tried to create an AVIF or WebP file that already existed, an error message would appear in the log. Now, it shows an informational message, but only if you use the `--verbose` option.
 
-To handle AVIF files, Optimizt uses the sharp module, which uses the libheif library. However, libheif doesn't support converting to animated AVIF (AVIS). In earlier versions, Optimizt would quietly convert animated GIFs into static AVIF. But from this version, an error will show up if you try to do this.
+To handle AVIF files, Optimizt uses the [sharp](https://sharp.pixelplumbing.com) module, which uses the libheif library. However, libheif [doesn't support](https://github.com/strukturag/libheif/issues/377) converting to animated AVIF (AVIS). In earlier versions, Optimizt would quietly convert animated GIFs into static AVIF. But from this version, an error will show up if you try to do this.
 
-The logic for creating file structures when using the --output option has also changed. Now, the original file structure will be recreated inside the output folder, starting from the folder passed to the app. Who knows how this worked before, but hopefully, it works better now!
+The logic for creating file structures when using the `--output` option has also changed. Now, the original file structure will be recreated inside the output folder, starting from the folder passed to the app. Who knows how this worked before, but hopefully, it works better now!
 
 
 ## 7.0.2 → 8.0.0