Skip to content

Commit

Permalink
docs(README): improve feature descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
bytexenon committed Nov 14, 2024
1 parent 0085da0 commit b12b867
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
# GitHub Desktop Notifier

> [!IMPORTANT]
> This is a Linux-only project.
[![License](https://img.shields.io/github/license/bytexenon/Github-Desktop-Notifier)](LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/bytexenon/Github-Desktop-Notifier)](https://github.com/bytexenon/Github-Desktop-Notifier/stargazers)

GitHub Desktop Notifier is a Python script that sends you a desktop notification whenever you receive a notification on GitHub. Stay updated with your GitHub activities without constantly checking your email or GitHub dashboard.
**GitHub Desktop Notifier** is an easy-to-use Python script that sends you a desktop notification whenever you receive a notification on GitHub. Stay updated with your GitHub activities without constantly checking your email or GitHub dashboard. Get instant desktop notifications for new issues, pull requests, comments, and more.

## Features

- **Real-time Notifications**: Get instant desktop notifications for new GitHub activities.
- **Interactive Actions**: Open notifications in your browser or mark them as read directly from the notification popup.
- **Supports All Notification Types**: Receive notifications for issues, pull requests, comments, and more.
- **Real-time Notifications**: Receive instant desktop alerts for new GitHub activities.
- **Interactive Actions**: Open notifications in your browser or mark them as read directly from the notification popup without opening your browser.
- **Supports All Notification Types**: Get notifications for issues, pull requests, comments, and more.
- **Easy to Use**: Simply run the script and authenticate with GitHub via browser to start receiving notifications, no need to create GitHub API tokens.

## Preview

![GitHub Desktop Notifier Preview](https://github.com/user-attachments/assets/63951238-ec37-433d-9ec2-aad393e6442e)

## Installation
## Getting Started

### Prerequisites

1. **Install required packages**: Install the `libnotify-bin` package to enable desktop notifications on Linux, and the `gh` package to interact with GitHub:
Before you begin, ensure you have the following installed:

- **Python 3**: The script is written in Python and requires Python 3 to run.
- **libnotify-bin**: Enables desktop notifications on Linux systems.
- **GitHub CLI (`gh`)**: Allows the script to interact with GitHub.

**Install required packages on Debian/Ubuntu:**

```bash
sudo apt update
sudo apt install libnotify-bin gh
sudo apt install -y python3 libnotify-bin gh
```

2. **Clone the Repository**: Download the script by cloning the repository.
Expand All @@ -36,16 +42,19 @@ cd Github-Desktop-Notifier

## Usage

Using GitHub Desktop Notifier is straightforward. Follow these steps to start receiving notifications:

1. **Run the Script**: Start the script to begin receiving notifications.

```bash
python src/__main__.py
```

**That's it!**
- If you haven't authenticated with `gh` (GitHub CLI), you'll be prompted to do so. Follow the instructions to authenticate via your web browser.
- After authenticating, the script will run in the background and send you desktop notifications for new GitHub activities.

If you haven't already authenticated with `gh`, you will be prompted to do so. Follow the printed instructions to authenticate with GitHub. Once you have done so, the script will run in the background and send you notifications for new GitHub activities.
**That's it!** You'll now receive desktop notifications for new GitHub activities. Click on the notification buttons to open the notification in your browser or mark it as read.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.

0 comments on commit b12b867

Please sign in to comment.