Skip to content

Commit

Permalink
Update README banner graphic; Update README formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
liquidz00 committed Jan 22, 2025
1 parent aed9e97 commit 4412607
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 16 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
<p align="left"><img src="docs/_static/patcher-readme-banner.svg" width="480"/></p>
<p align="left">
<a href="https://patcher.liquidzoo.io/">
<img src="docs/_static/patcher-banner-readme.svg" width="540"/>
</a>
</p>

![](https://img.shields.io/pypi/l/patcherctl)&nbsp;![](https://img.shields.io/badge/Python-3.10+-3776AB.svg?style=flat&logo=python&logoColor=white)&nbsp;![](https://img.shields.io/github/v/release/liquidz00/Patcher?color=orange)&nbsp;![](https://github.com/liquidz00/patcher/actions/workflows/pytest.yml/badge.svg)&nbsp;![](https://img.shields.io/pypi/v/patcherctl?color=yellow)

----

# What is Patcher?
Patcher leverages the Jamf Pro API to fetch patch management data and generate comprehensive reports in both Excel and PDF formats. It simplifies tracking and reporting on software update compliance across macOS devices managed through Jamf Pro.

Expand All @@ -21,12 +27,12 @@ pip install patcherctl
> [!NOTE]
> Please note that while Patcher is installed as a package, it is meant to be used as a command line tool and not as an imported library.
*Why `patcherctl?` The pip package is called patcherctl because the name patcher was already taken on PyPI. Despite this, the project itself is referred to as Patcher*
> Why `patcherctl?` The pip package is called patcherctl because the name patcher was already taken on PyPI. Despite this, the project itself is referred to as Patcher*
### Usage
After installation, you can generate reports by running the main script. You can specify the output directory for the reports and choose to generate PDF reports alongside Excel files.
After installation, you can generate reports by running the `export` command. You can specify the output directory for the reports and choose to generate PDF reports alongside Excel files.
```shell
patcherctl --path '/path/to/output/directory' [--pdf]
patcherctl export --path '/path/to/output/directory' [--pdf]
```

For a list of all available command options, visit the [usage page](https://patcher.liquidzoo.io/user/usage.html) of our documentation.
Expand Down
1 change: 1 addition & 0 deletions docs/_static/patcher-banner-readme.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 0 additions & 12 deletions docs/_static/patcher-readme-banner.svg

This file was deleted.

0 comments on commit 4412607

Please sign in to comment.