ID

68d28a8

date

2024-08-20 16:20:01+00:00

author

Alex Chan <alex@alexwlchan.net>

parent

d260488

message

Improve the README intro

changed files

1 file, 19 additions, 6 deletions

• README.md

Changed files

README.md (1282) → README.md (1842)

diff --git a/README.md b/README.md
index 19166fb..a1c6974 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,22 @@
 
 This is a simple command-line tool for creating image thumbnails.
 
-You tell it your original image, the directory where you're storing thumbnails, and the max width/height of the thumbnail you want to create.
-It prints the path to the newly-created thumbnail.
+It takes three arguments:
+
+*   Your original image;
+*   The directory where you're storing thumbnails;
+*   The max allowed height or width of the thumbnail you want.
+    You constrain in one dimension, and it resizes the image to fit, preserving the aspect ratio of the original image.
+
+The tool prints the path to the newly-created thumbnail.
+Here are two examples:
 
 ```console
-$ create_thumbnail cat.jpg --out-dir=thumbnails --width=150
-./thumbnails/cat.jpg
+$ create_thumbnail clever_cat.jpg --out-dir=thumbnails --width=100
+./thumbnails/clever_cat.jpg
 
-$ create_thumbnail dog.png --out-dir=thumbnails --height=200
-./thumbnails/dog.png
+$ create_thumbnail dappy_dog.png --out-dir=thumbnails --height=250
+./thumbnails/dappy_dog.png
 
 $ create_thumbnail --help
 Usage: create_thumbnail --out-dir <OUT_DIR> <--height <HEIGHT>|--width <WIDTH>> <PATH>
@@ -19,6 +26,12 @@ Usage: create_thumbnail --out-dir <OUT_DIR> <--height <HEIGHT>|--width <WIDTH>> 
 It supports JPEG, PNG, TIFF, WEBP, and both static and animated GIFs.
 Thumbnails match the format of the original image, except for animated GIFs, which become MP4 movies.
 
+This tool only does one thing: it creates thumbnails that I like.
+I need image thumbnails in a lot of projects, and I wanted a single tool I could use in all of them rather than having multiple copies of the same code.
+
+You might prefer to look at flexible tools like ImageMagick or ffmpeg, which have more customisation to fit a wider variety of use cases.
+
+
 
 
 ## Installation