Update README.md

This commit is contained in:
Matt Strenk 2024-01-09 01:43:22 -05:00
parent b2ccbe42ce
commit 9d1ea91a99

View File

@ -1,13 +1,14 @@
# JBOPS - Just a Bunch Of Plex Scripts
Most of these scripts utilize a combination of [Tautulli](https://github.com/Tautulli/Tautulli), [python-plexapi](https://github.com/pkkid/python-plexapi), and [requests](http://docs.python-requests.org/en/master/user/install/#install).
## Usage
Clone this repo to get started!
> [!TIP]
> Each of the scripts has a help menu that can be displayed with either `-h` or `--help`
### Docker (with make)
Edit the config.ini file to include your information.
@ -29,6 +30,7 @@ docker run --rm -v .:/usr/src/app jbops python3 utility/library_growth.py -h
> [!NOTE]
> You can either use the config.ini file to configure the scripts or you can edit each of the scripts manually.
>
> For use of config.ini for common variables please use [plexapi.CONFIG](http://python-plexapi.readthedocs.io/en/latest/configuration.html)
> Default location `~/.config/plexapi/config.ini`
> ```python
@ -47,9 +49,6 @@ Run the scripts
python3 utility/library_growth.py -h
```
> [!TIP]
> Each of the scripts has a help menu that can be displayed with either `-h` or `--help`
### Contact
[![PM](https://img.shields.io/badge/Discord-Scripts-lightgrey.svg?colorB=7289da)](https://discord.gg/tQcWEUp) [![PM](https://img.shields.io/badge/Reddit-Message-lightgrey.svg)](https://www.reddit.com/user/Blacktwin/) [![PM](https://img.shields.io/badge/Plex-Message-orange.svg)](https://forums.plex.tv/u/blacktwin) [![Issue](https://img.shields.io/badge/Submit-Issue-red.svg)](https://github.com/blacktwin/JBOPS/issues/new)