Merge pull request #75 from TheRenegadeCoder/v2.4.0

Cleaned up Documentation

README.md

@@ -2,14 +2,8 @@
 
 [![Join the chat at https://gitter.im/TheRenegadeCoder/image-titler](https://badges.gitter.im/TheRenegadeCoder/image-titler.svg)](https://gitter.im/TheRenegadeCoder/image-titler?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-Adds a title to an image using The Renegade Coder Featured Image style. The style can be
-defined as the following:
-
-> Titles are split in half by the closest space and displayed using two solid red bars
-> with a white text overlay on the upper right portion of the image. In addition, logos
-> can be added which will affect the bar color. 
-
-For example:
+The Image Titler is a tool which provides options for generating thumbnails for various social media platforms.
+Currently, the tool has a predefined style which looks roughly like the following image:
 
 ![23 Tech Topics to Tackle](https://raw.githubusercontent.com/TheRenegadeCoder/image-titler/master/samples/v1.8.0/23-tech-topics-to-tackle-featured-image-v1-8-0.JPEG)
 
@@ -30,34 +24,30 @@ image-titler --tier "free"  # Sets the membership tier which changes the rectang
 image-titler --logo_path "path/to/logo"  # Adds a 145x145 logo to the lower left corner of the image
 image-titler --batch  # Runs the program in batch mode on a directory
 image-titler --font "path/to/font"  # Changes the default title font
+image-titler --size YouTube  # Changes the aspect ratio of the output file
 ```
 
 Alternatively, you can spin up the GUI version of the software as of 2.0.0 as follows:
 
 ```shell
 image-titler-gui
-```
-
-Since 2.2.0, all the CLI commands from above will work to populate the GUI as well. Try
-some of these:
 
-```shell
+# Options can be used to preload GUI as of 2.2.0
 image-titler-gui --title "Hello, World!"  # Adds a custom title
 image-titler-gui --output_path "path/to/output"  # Sets the output path
 image-titler-gui --path "path/to/image"  # Sets the image path
 image-titler-gui --tier "free"  # Sets the membership tier which changes the rectangle borders
 image-titler-gui --logo_path "path/to/logo"  # Adds a 145x145 logo to the lower left corner of the image
 image-titler-gui --batch  # Runs the program in batch mode on a directory
 image-titler-gui --font "path/to/font"  # Changes the default title font
+image-titler-gui --size YouTube  # Changes the aspect ratio of the output file
 ```
 
 ## Default Behavior
 
 Currently, the image-titler script makes a few assumptions about the images it 
 processes automatically: 
 
-- The size of an image is assumed to be 1920x960. Otherwise, this tool 
-will automatically crop the image to size. 
 - This tool scrapes file names for image titles. To do this, it assumes 
 file names are written in kebab-case where each word is separated by a hyphen.
 Then, words are extracted and title cased before being printed on the image.
@@ -69,3 +59,18 @@ Titles will always appear in the top right.
 
 There are likely other default behaviors not documented here. Feel free to experiment
 with the tool and share any issues you find. 
+
+## Full List of Options
+
+Here's a description of all the option used in the samples above.
+
+| Option | Domain | Description |
+|--------|--------|-------------|
+| --batch, -b | True/False | Turns on batch processing |
+| --font, -f | Any valid font file | Overrides the default title font |
+| --logo_path, -l | Any valid image file | Loads a logo onto the input image |
+| --output_path, -o | Any valid directory | Determines where files will be saved (has no effect in GUI) |  
+| --path, -p | Any valid file or directory | Loads the input image (or directory when in batch mode) |
+| --size, -s | Choose between "Twitter", "WordPress", and "YouTube" | Sets the aspect ratio of the output image |
+| --tier, -r | Choose between "free" (silver) or "premium" (gold) | Adds a border color to the title |
+| --title, -t | Any string | Overrides the automatic title feature |

setup.py

@@ -5,10 +5,10 @@
 
 setuptools.setup(
     name="image-titler",
-    version="2.3.0",
+    version="2.3.1",
     author="The Renegade Coder",
     author_email="[email protected]",
-    description="A image processing utility which provides options for generating thumbnails for various social media platforms.",
+    description="An image processing utility which provides options for generating thumbnails for various social media platforms.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/TheRenegadeCoder/image-titler",