ID

859e95e

date

2026-09-26 16:03:41+00:00

author

Alex Chan <alex@alexwlchan.net>

parent

d77da1f

message

README: update the README to note PDF support, and remove GitHub links

changed files

1 file, 3 additions, 6 deletions

• README.md

Changed files

README.md (1810 → 1639)

diff --git a/README.md b/README.md
index 496c4af..49ae249 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ $ create_thumbnail --help
 Usage: create_thumbnail --out-dir <OUT_DIR> <--height <HEIGHT>|--width <WIDTH>> <PATH>
 ```
 
-It supports JPEG, PNG, TIFF, WEBP, and both static and animated GIFs.
+It supports JPEG, PNG, TIFF, WEBP, PDF, 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.
@@ -36,14 +36,11 @@ You might prefer to look at flexible tools like ImageMagick or ffmpeg, which hav
 
 ## Installation
 
-You can download compiled binaries from the [GitHub releases](https://github.com/alexwlchan/create_thumbnail/releases).
-
-Alternatively, you can install from source.
-You need Rust installed; I recommend using [Rustup].
+Install Rust; I recommend using [Rustup].
 Then clone this repository and compile the code:
 
 ```console
-$ git clone "https://github.com/alexwlchan/create_thumbnail.git"
+$ git clone "git://alexwlchan.net/projects/create_thumbnail.git"
 $ cd dominant_colours
 $ cargo install --path .
 ```