Update README

This commit is contained in:
Telesphoreo 2022-03-05 19:27:34 -06:00
parent eb239f60b0
commit 45eba6029b
2 changed files with 10 additions and 1 deletions

View file

@ -1,2 +1,12 @@
# IBConverter
Convert TotalFreedomMod's indefinite bans to Plex's format
## Requirements
This project requires Python 2.7 or later. You will also need `pip` installed.
IBConverter will automatically install `pyyaml` for you.
## How to use
The script will ask you for the path to the TotalFreedomMod indefinitebans.yml file.
Once you enter it, the script will automatically convert every entry from TotalFreedom to Plex.
The Plex file will be saved as `indefbans.yml` in the directory you ran the script from.
Therefore, it is important you do not have the TotalFreedomMod file have the name `indefbans.yml` when running the script.

View file

@ -44,6 +44,5 @@ def main():
print("-----------------------------------------------------------------------------------------------")
# Press the green button in the gutter to run the script.
if __name__ == '__main__':
main()