Skip to content

Commit

Permalink
docs: Add logo/favicon and screenshot to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joshooaj committed Mar 20, 2024
1 parent b95b062 commit 38e592b
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# PSPushover

## Overview

The PSPushover PowerShell module makes it a breeze to send push notifications to any device using the
[Pushover](https://pushover.net) service from PowerShell on Windows, Linux, and MacOS. You can send push notifications to Android, iOS, and
desktop devices.
Expand All @@ -13,18 +11,20 @@ to a group of users. Get notified...
- when cron jobs run
- when servers restart
- when your GitHub Actions / Azure DevOps / Jenkins / GitLab pipelines fail
- when your home automation detects a leak
- [when someone star's your GitHub repo](https://github.com/joshooaj/PSPushover/blob/main/.github/workflows/NotifyOnStarred.yml)
- __whenever and for whatever you want!__

## Try it out
## :material-star-shooting: Try it out

![Screenshot of Pushover notification on iOS](assets/images/example-notification.jpg)

When this GitHub repository receives a new star, it triggers a GitHub Action [workflow](https://github.com/joshooaj/PSPushover/blob/main/.github/workflows/NotifyOnStarred.yml) which uses PSPushover to send a notification to anyone who subscribes using the link below.

[Subscribe to Star Notifications](https://pushover.net/subscribe/PSPushover-2hw5raj6uqr5dsw)

Pushover will generate a random user token for you and add it to a distribution group. You can unsubscribe from your Pushover dashboard at any time, and your real user token is never exposed. So go ahead and try it out! If you already had the repo starred before subscribing, you can unstar and star it again as many times as you like.

## Getting started
## :fontawesome-solid-person-walking-arrow-right: Getting started

All Pushover notifications are sent from an __application__ to a __user__ or __group__. To send
your first push notification, you need an __application token__ and a __user key__. To receive
Expand Down
Binary file added docs/assets/images/example-notification.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/joshooaj.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/pushover-icon-256.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/pushover-icon-512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/assets/images/pushover-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ remote_branch: gh-pages

theme:
name: material
logo: assets/images/joshooaj.png
favicon: assets/images/joshooaj.png
font:
text: Roboto
code: Roboto Mono
icon:
repo: material/github
palette:
Expand Down

0 comments on commit 38e592b

Please sign in to comment.