Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Luu <[email protected]>
  • Loading branch information
RyanLua authored Jul 14, 2024
1 parent 932748f commit f48c8ca
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,18 @@ Monitor Instagram accounts for new posts and send them to a Discord webhook.
* Customizable **Discord embeds** for new posts and message contents including **mentions/pings**
* **User-definable refresh interval** for checking for new posts the second they are posted

```console
python instawebhooks.py <instagram_username> <discord_webhook_url>
```

<img alt="Example of a new post notification" src="assets/ScreenshotEmbedExample.png" height="512px" />

## Installation

Before installing, make sure you have [Python 3.8 or newer](https://www.python.org/downloads/) installed.

1. [Clone the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) onto your machine
```console
```
git clone https://github.com/RyanLua/InstaWebhooks.git
```
2. Install the required Python packages by running the following command in the repository directory:
```console
```
pip install -r requirements.txt
```

Expand All @@ -41,17 +37,21 @@ Now you are ready to use the script! See the [Usage](#usage) section for more in
Usage is simple once you have everything installed, just run the script with the Instagram username you want to monitor and the Discord webhook URL you want to send new posts to.

An example of monitoring the Instagram account `raenlua` and sending new posts to a Discord webhook URL:
```console
```
python instawebhooks.py raenlua https://discord.com/api/webhooks/1256506980734992447/GnM79-OWCDQ935_hPp6zY0DCHopS8uBWTgjgEI9OTrXZFqayDcfiMYo_CvhYPWvDTB3h
```

You can also use the optional arguments to customize the behavior of the script. For example, to check for new posts every 1800 seconds (30 minutes):
```console
```
python instawebhooks.py raenlua https://discord.com/api/webhooks/1256506980734992447/GnM79-OWCDQ935_hPp6zY0DCHopS8uBWTgjgEI9OTrXZFqayDcfiMYo_CvhYPWvDTB3h -i 1800
```

For more on different arguments you can use, see [Documentation](#documentation).

## Documentation

The different arguments you can use are very simple. Below are all the arguments you can use and what they do.

### Arguments
* `instagram_username`: The Instagram username to monitor for new posts.
* `discord_webhook_url`: The Discord webhook URL to send new posts to.
Expand Down

0 comments on commit f48c8ca

Please sign in to comment.