Create a 1.0 with a basic README

ID

1574752

date

2024-08-20 12:23:52+00:00

author

Alex Chan <alex@alexwlchan.net>

parent

b7d58cf

message

Create a 1.0 with a basic README

changed files

4 files, 50 additions, 13 deletions

CHANGELOG.md
Cargo.lock
Cargo.toml
README.md

Changed files

CHANGELOG.md (0) → CHANGELOG.md (54)

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..59f4f29
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+## v1.0.0 - 2024-08-20
+
+Initial release.

Cargo.lock (37401) → Cargo.lock (37401)

diff --git a/Cargo.lock b/Cargo.lock
index 6cf08e1..48b7873 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -295,7 +295,7 @@ dependencies = [
 
 [[package]]
 name = "create_thumbnail"
-version = "0.1.0"
+version = "1.0.0"
 dependencies = [
  "assert_cmd",
  "clap",

Cargo.toml (209) → Cargo.toml (209)

diff --git a/Cargo.toml b/Cargo.toml
index a472dc4..36478b2 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "create_thumbnail"
-version = "0.1.0"
+version = "1.0.0"
 edition = "2021"
 
 [dependencies]

README.md (623) → README.md (1282)

diff --git a/README.md b/README.md
index 81a0f47..19166fb 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,46 @@
-create-thumbnail PATH [--width=WIDTH | --height=HEIGHT] --out-dir=OUT_DIR
+# create_thumbnail
 
-focusing on a small piece of code makes it better
+This is a simple command-line tool for creating image thumbnails.
 
-"DRY" / rule of three / https://en.wikipedia.org/wiki/Rule_of_three_(computer_programming)
-good at doing inside a single project
-but not across project
-this is thumbnailing code that I've written across at least half a dozen projects
-but it's always an adjunct to the main rpoject
-never made it a project on its own so it's always a slightly rushed, half-baked bit of code
-pul it out into its own project!
+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.
 
-thumbnails = don't feel need in local dev, cos everything is whizzy fast
-much better here
+```console
+$ create_thumbnail cat.jpg --out-dir=thumbnails --width=150
+./thumbnails/cat.jpg
+
+$ create_thumbnail dog.png --out-dir=thumbnails --height=200
+./thumbnails/dog.png
+
+$ 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.
+Thumbnails match the format of the original image, except for animated GIFs, which become MP4 movies.
+
+
+
+## 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].
+Then clone this repository and compile the code:
+
+```console
+$ git clone "https://github.com/alexwlchan/create_thumbnail.git"
+$ cd dominant_colours
+$ cargo install --path .
+```
+
+For animated GIF support, you additionally need to install `ffmpeg`.
+
+[Rustup]: https://rustup.rs/
+
+
+
+## License
+
+MIT.