diff --git a/README.md b/README.md index baaaa7e..0177f1d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ PDF compress tool, using iLovePDF API ## Prerequisites The application is compatible with Windows and Linux based systems. -Python version 3.4 or above is assumed to be installed, as well as pip package manager utility and setuptools module. +Python version 3.5 or above is assumed to be installed, as well as pip package manager utility and setuptools module. ## Installation ```bash @@ -27,15 +27,20 @@ The value can be configured using: ```bash pdfworkshop config public_key new_public_key_value ``` -The input/ouput directories can also be configured. -Their default values are set to a directory called 'input' and 'output' -according to the current path from where the tool was called. +The input/ouput directories can also be configured, although not advised. +Their default values are set to the current directory and another _output_ directory, +according to the path from where the tool was called. ## Commands - list-config - list tool configuration values - config \ \ - edit tool configuration values - run - compress all PDF files stored in input_dir, storing the result in output_dir +## How to use +By default, the PDF files to compress should be on the directory from where the tool will be called. +After using the _run_ command, an _output_ directory will be created, where all compressed +files will be stored. + ## Example run To exercise some of the available commands, one can try to: diff --git a/pdfworkshop/config.ini b/pdfworkshop/config.ini index 60c3647..aa08b39 100644 --- a/pdfworkshop/config.ini +++ b/pdfworkshop/config.ini @@ -1,5 +1,5 @@ [DEFAULT] -input_dir = ./input/ +input_dir = ./ output_dir = ./output/ [User] diff --git a/setup.py b/setup.py index 825a367..14e4f5a 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from setuptools import setup, find_packages __application__ = 'pdfworkshop' -__version__ = '1.0.0' +__version__ = '1.0.1' setup( name=__application__,