diff --git a/README.md b/README.md index ea4dc675..5ede9cef 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # trueupdate A TrueCharts automatic and bulk update utility + +## How to install + +run `pip install trueupdate` + +Please be aware you will need to reinstall after every SCALE update + +## How to Update + +run `pip install --upgrade trueupdate` + +## How to use + +Just run `trueupdate` in the shell of your TrueNAS SCALE machine, to have it process Patch and Minor version updates for all Apps + +Additional options are available: + +- `trueupdate CATALOG` where CATALOG is the name of the catalog you want to process in caps +- `trueupdate Semver` where semver is the highest semver version you want to process. options: `patch`, `minor` and `major` \ No newline at end of file diff --git a/setup.py b/setup.py index c8f8c966..8bb847af 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ README_MD = open(join(dirname(abspath(__file__)), "README.md")).read() setup( name="trueupdate", - version="1.0.2", + version="1.0.3", # The packages that constitute your project. # For my project, I have only one - "pydash". diff --git a/trueupdate/command_line.py b/trueupdate/command_line.py index ff1879eb..61007677 100644 --- a/trueupdate/command_line.py +++ b/trueupdate/command_line.py @@ -1,4 +1,4 @@ import trueupdate def main(): - print trueupdate.run() \ No newline at end of file + trueupdate.run() \ No newline at end of file