Apply Prettier to README
MODIFY
README.md
README.md
@@ -35,17 +35,20 @@ To install this project on Linux, macOS or Windows WSL:
- Verify the latest release at https://github.com/Taxel/PlexTraktSync/releases
- Download the `.tar` or `.zip`
- *or* checkout the release with Git (For example, the command to clone with Git):
+ _or_ checkout the release with Git (For example, the command to clone with Git):
+
```
git clone -b 0.7.19 --depth=1 https://github.com/Taxel/PlexTraktSync
```
- In the extracted directory, install the required Python packages:
+
```
python3 -m pip install -r requirements.txt
```
- *or* alternatively you can use [pipenv]:
+ _or_ alternatively you can use [pipenv]:
+
```
python3 -m pip install pipenv
pipenv install
@@ -79,7 +82,9 @@ docker-compose run --rm plex-trakt-sync watch
```
## Setup
+
- You will need to create a Trakt API app if you do not already have one:
+
- Visit https://trakt.tv/oauth/applications/new
- Give it a meaningful name
- Enter `urn:ietf:wg:oauth:2.0:oob` as the redirect url
@@ -88,12 +93,14 @@ docker-compose run --rm plex-trakt-sync watch
- Run `python3 -m plex_trakt_sync`.
- At first run you will be asked to setup Trakt and Plex access.
+
Follow the instructions, your credentials and API keys will be stored in
`.env` and `.pytrakt.json` files.
+
If you have [2 Factor Authentication enabled on Plex](https://support.plex.tv/articles/two-factor-authentication/#toc-1:~:text=Old%20Third%2DParty%20Apps%20%26%20Tools) you can append the code to your password.
+* Cronjobs can be optionally used on Linux or macOS to run the script at set intervals.
-- Cronjobs can be optionally used on Linux or macOS to run the script at set intervals.
For example, to run this script in a cronjob every two hours:
```
crontab -e
@@ -103,7 +110,7 @@ docker-compose run --rm plex-trakt-sync watch
## Windows Setup (optional alternative)
- Download the latest `.zip` release from https://github.com/Taxel/PlexTraktSync/releases
-- Run `setup.bat` to install requirements and create optional shortcuts and routines *(requires Windows 7sp1 - 11)*.
+- Run `setup.bat` to install requirements and create optional shortcuts and routines _(requires Windows 7sp1 - 11)_.
## Sync settings
@@ -131,6 +138,7 @@ sync) you can copy and edit `config.json` before launching the script.
You can view sync progress in the `last_update.log` file which will be created.
## Commands
+
### Sync
The `sync` subcommand supports `--sync=tv` and `--sync=movies` options,
@@ -148,12 +156,15 @@ Options:
```
### Unmatched
+
You can use `unmatched` command to scan your library and display unmatched movies.
+
Support for unmatched shows is not yet implemented.
`python3 -m plex_trakt_sync unmatched`
### Watch
+
You can use the `watch` command to listen to events from Plex Media Server
and scrobble plays.

Apply Prettier to README