Merge pull request #24 from achimoraites/docs/readme

Docs/readme

Author: achimoraites

.all-contributorsrc

@@ -0,0 +1,4 @@
+{
+  "projectName": "Python-Image-Converter",
+  "projectOwner": "achimoraites"
+}

README.md

@@ -1,23 +1,15 @@
 # Python Image Converter
 [![PyPI version](https://badge.fury.io/py/raw-image-converter.svg)](https://pypi.org/project/raw-image-converter/)
+[![All Contributors](https://img.shields.io/github/all-contributors/achimoraites/Python-Image-Converter?color=ee8449&style=flat-square)](#contributors)
 
 
-## This is a simple Image converter written in Python
-The app is using PIL ,rawpy and imageio . 
-Files are converted to .jpg format 
+The Python Image Converter is a user-friendly CLI tool designed for hassle-free batch conversion of image files.
 
-## Convert for FREE multiple image files
-I saw all kinds of software out there but when you have hundrends of raw images is tedious to convert 
-one by one! Other Options were to get program suits like photoshop or even pay! 
-# Notes
-The .ai files are renamed as .pdf and moved to the converted directory !!! 
-
-
-# What files can be used ?
-### DNG , CR2 , CRW, NEF , PEF, ERF , ORF , PPM , MOS , MRF , MRW , SRW and more!!!
-Personally i convert a lot of .psd , .TIF and .dng files !!! 
-## Speed
-This script is multithreaded and checks if you have already converted an image!
+## Features
+- **Bulk Conversion:** Say goodbye to the tedious one-by-one image conversion. Convert hundreds of images at once.
+- **Supported File Types:** DNG, CR2, CRW, NEF, PEF, ERF, ORF, PPM, MOS, MRF, MRW, SRW, PSD, TIF, and more.
+- **Fast:** Multi-core support.
+- **Customizable Output:** Specify your converted images' output directory, resolution, and format
 
 ## Install
 
@@ -26,8 +18,7 @@ This script is multithreaded and checks if you have already converted an image!
 $ pip3 install raw_image_converter
 ```
 
-### Running it from the repo
-In that case using an virtual environment is recommended
+### Running it from the repo 
 
 ```bash
  git clone https://github.com/achimoraites/Python-Image-Converter.git [my-app-name]
@@ -41,10 +32,10 @@ In that case using an virtual environment is recommended
 
 ### Arguments
 - `-s, --src` (required): set the path to the directory you want to convert (source)! 
-- `-t, --tgt`: where to store the converted images (target), by default they are stored in the "converted" folder. 
-- `-d, --delete-source-directory`: removes the directory with the original images (source) 
-- `-r, --resolution`: Allows to set the converted image resolutions, you can use numbers or percentages: eg 75% -> width and height are 75% of the original size, 1000,1500 sets the width to 1000px and the height to 1500px
-- `-e, --ext`: specify the converted image format that will be used for the converted images; by default the `.jpg` is used. valid options are:
+- `-t, --tgt`: where to store the converted images (target); by default, they are stored in the "converted" folder. 
+- `-d, --delete-source-directory`: removes the directory with the original images (source).
+- `-r, --resolution`: allows to set the converted image resolutions; you can use numbers or percentages: e.g., 75% -> width and height are 75% of the original size, 1000,1500 -> width to 1000px and the height to 1500px
+- `-e, --ext`: specify the output image format for the converted images; by default, it is JPG. Valid options are:
     - `.jpg`
     - `.png`
 
@@ -66,10 +57,19 @@ In that case using an virtual environment is recommended
 ```
 
 
-
-
 And you are done! 
 
 ## ScreenShot
 <img src='https://raw.githubusercontent.com/achimoraites/Python-Image-Converter/master/sample.png' alt='Python Image Converter'>
 
+
+## Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

raw_image_converter/__init__.py

@@ -5,4 +5,4 @@
 """
 
 # Version of the package
-__version__ = "1.0.3"
+__version__ = "1.1.1"

raw_image_converter/__main__.py

@@ -1,5 +1,6 @@
 from datetime import datetime
 import os
+from raw_image_converter import __version__
 from raw_image_converter.utils import (
     check_file_type,
     convert_file,
@@ -18,7 +19,7 @@ def tuple_type(values):
 
 
 def main():
-    print("### PYTHON IMAGE CONVERTER ### \n \n")
+    print(f"### PYTHON IMAGE CONVERTER {__version__} ### \n \n")
 
     parser = argparse.ArgumentParser(description="Convert images to JPG/PNG")
     parser.add_argument(

setup.py

@@ -10,7 +10,7 @@
 # This call to setup() does all the work
 setup(
     name="raw-image-converter",
-    version="1.1.0",
+    version="1.1.1",
     description="Batch conversions of raw images",
     long_description=README,
     long_description_content_type="text/markdown",