diff --git a/README.md b/README.md index 78c14b3..8a8df88 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,18 @@ ![image](https://user-images.githubusercontent.com/59180111/168054648-af0590fd-9bd7-42d0-91b2-d7974643debd.png) -A Python script that displays your [Plex](https://www.plex.tv) status on [Discord](https://discord.com) using [Rich Presence](https://discord.com/developers/docs/rich-presence/how-to). +A Python script that displays your [Plex](https://www.plex.tv/) status on [Discord](https://discord.com/) using [Rich Presence](https://discord.com/developers/docs/rich-presence/how-to). Current Version: 2.3.0 ## Getting Started -1. Install [Python 3.10](https://www.python.org/downloads/) - Make sure to tick "Add Python 3.10 to PATH" during the installation -2. Download [this repository's contents](https://github.com/phin05/discord-rich-presence-plex/archive/refs/heads/master.zip) -3. Extract the folder contained in the above ZIP file -4. Navigate a command-line interface (cmd.exe, PowerShell, bash, etc.) into the above-extracted directory -5. Install the required Python modules by running `python -m pip install -U -r requirements.txt` -6. Start the script by running `python main.py` +1. Install [Python 3.10](https://www.python.org/downloads/) - Make sure to tick "Add Python 3.10 to PATH" during the installation. +2. Download [this repository's contents](https://github.com/phin05/discord-rich-presence-plex/archive/refs/heads/master.zip). +3. Extract the folder contained in the above ZIP file. +4. Navigate a command-line interface (cmd.exe, PowerShell, bash, etc.) into the above-extracted directory. +5. Install the required Python modules by running `python -m pip install -U -r requirements.txt`. +6. Start the script by running `python main.py`. When the script runs for the first time, a `config.json` file will be created in the working directory and you will be prompted to complete the authentication flow to allow the script to retrieve an access token for your Plex account. @@ -44,9 +44,9 @@ The script must be running on the same machine as your Discord client. ### Obtaining an Imgur client ID -1. Go to Imgur's [application registration page](https://api.imgur.com/oauth2/addclient) -2. Enter any name for the application and pick OAuth2 without a callback URL as the authorisation type -3. Submit the form to obtain your application's client ID +1. Go to Imgur's [application registration page](https://api.imgur.com/oauth2/addclient). +2. Enter any name for the application and pick OAuth2 without a callback URL as the authorisation type. +3. Submit the form to obtain your application's client ID. ### Buttons @@ -81,7 +81,7 @@ During runtime, the following dynamic URL placeholders will get replaced with re }, { "label": "My YouTube Channel", - "url": "https://www.youtube.com/" + "url": "https://www.youtube.com/channel/me" } ] },