Polished up the example with better images and explanations

adrianboston · Nov 29, 2021 · cecf7f9 · cecf7f9
1 parent 48b6658
commit cecf7f9
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 3 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Adrian
+Copyright (c) 2021 Adrian Boston
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -78,7 +78,7 @@ The resulting tag is:
 <img src="my_image/legacy.jpg" srcset="my_image/320w.jpg 320w, my_image/480w.jpg 480w, my_image/640w.jpg 640w, my_image/768w.jpg 768w, my_image/960w.jpg 960w, my_image/1024w.jpg 1024w, my_image/1280w.jpg 1280w, my_image/1440w.png 1440w" sizes="(min-width: 768px) 50vw, 100vw" alt="A file named my_image">
 ```
 
-Warnings and erros can be piped into a file to avoid cluttering the console. The most common warning is skipping a file due to its small size less than the `-m` directive.
+Warnings and errors can be piped into a file to avoid cluttering the console. The most common warning is skipping a file due to its small size less than the `-m` directive.
 
 srcset examples/simple/test.png 2>srcset.err
 

diff --git a/examples/simple/README.md b/examples/simple/README.md
@@ -0,0 +1,21 @@
+
+# Simple Example
+
+
+Convert the provided Library of Congress [Free To Use](https://www.loc.gov/free-to-use/)  images using srcset 
+
+#### A verbose dry run using the test `-z` directive on an example `tif` image, converting to `jpg` format:
+
+`srcset examples/simple/pnp-bellcm-10100-10106u.tif -t jpg -vz`
+
+#### A verbose dry run using the `-z` directive on the second example `tif` image, converting to `png` format:
+
+`srcset examples/simple/pnp-fsa-8c02000-8c02400u -t png -vz`
+
+#### Convert both images to `jpg` using the recurse `-r` option and dump the images in the `/var/www/images` directory.
+
+```
+srcset examples/simple -r -t jpg -o /var/www/images -v
+```
+
+
diff --git a/examples/simple/Shooting_the_Rapids_1879.jpg b/examples/simple/Shooting_the_Rapids_1879.jpg
diff --git a/examples/simple/test.png b/examples/simple/test.png
diff --git a/src/main.rs b/src/main.rs
@@ -164,7 +164,7 @@ fn loop_path(dir: &Path, prog_options: &ProgOptions)  -> anyhow::Result<()>
                 {
                     None => (),
                     Some("jpg") | Some("JPG") | Some("png") | Some("PNG")
-                        | Some("tiff") | Some("TIFF")
+                        | Some("tiff") | Some("TIFF") | Some("tif") | Some("TIF")
                             => {
                                     if path.metadata()?.len() > prog_options.min_size
                                     {