Skip to content

Commit

Permalink
Updated authors and prerequisites.
Browse files Browse the repository at this point in the history
  • Loading branch information
liquidz00 committed Mar 6, 2024
1 parent 4c3903d commit 6f63cf0
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Patcher leverages the Jamf Pro API to fetch patch management data and generate c
- Read Computers, Read Patch Reporting roles
- Client ID
- Client Secret
- Bearer Token
- Bearer Token (Optional, installer script can generate one for you)

> **Note**<br>
> Although not required, it is **highly recommended** to create an API client for use with Patcher. For more details, reference the [Jamf Pro Documentation](https://learn.jamf.com/bundle/jamf-pro-documentation-current/page/API_Roles_and_Clients.html) on API Roles and Clients.
Expand All @@ -42,7 +42,7 @@ The installer script will guide you through setting up your Jamf Pro instance de
chmod +x installer.sh
./installer.sh
```
Follow the prompts to enter your Jamf Pro URL, Client ID, Client Secret, and Token. You'll also be asked to customize the report header and footer text. Optionally, you can opt to use a custom font instead of the default font [Assistant](https://fonts.google.com/specimen/Assistant).
Follow the prompts to enter your Jamf Pro URL, Client ID, and Client Secret. If you already have a Bearer Token, you can pass the value to the installer script, otherwise the installer script will generate one for you. You'll also be asked to customize the report header and footer text. Optionally, you can opt to use a custom font instead of the default font [Assistant](https://fonts.google.com/specimen/Assistant).

### 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.
Expand All @@ -55,11 +55,9 @@ python patcher.py --path /path/to/output/directory [--pdf]
### Customizing Report UI
To customize the UI elements like header and footer text after the initial setup, edit the `ui_config.py` file in the project directory. Changes will be reflected in subsequent reports.

## Contributing
Contributions to Patcher are welcome! Please feel free to submit pull requests or create issues for bugs, questions, or new feature requests.
## Authors & Contributions
Patcher is co-authored by [Andrew Speciale - @liquidz00](https://github.com/liquidz00) and [Chris Ball - @ball42](https://github.com/ball42). Contributions to Patcher are welcome! Please feel free to submit pull requests or create issues for bugs, questions, or new feature requests.

## License
This project is licensed under the Apache 2.0 License. See LICENSE.txt for details.



Expand Down

0 comments on commit 6f63cf0

Please sign in to comment.