Add generated TRaSH-Guides with scripts

README.md

@@ -1,57 +1,29 @@
-# Dictionary Database Repository
+# Unofficial TRaSH-Guides Database Repository
 
-This repository hosts Dictionary's database containing:
+This repository hosts [TRaSH-Guides's](https://trash-guides.info/) unofficial database for Profilarr containing:
 
 - Regex Patterns
 - Custom Formats
 - Quality Profiles
 
-The database serves two main purposes:
-
-1. Powers our website and wiki documentation
-2. Provides import files for the Profilarr application
-
-## Branches
-
-### Stable
-
-Contains thoroughly tested and verified database entries ready for production use. All entries have gone through our quality assurance process.
-
-### Dev
-
-Contains the latest updates and additions that are pending formal verification. May include experimental patterns and profiles that require further testing.
+The goal of this repository is to generate a Profilarr database based on TRaSH-Guides configuration.
 
 ## Scripts
 
-The repository includes utility scripts to help maintain and generate database entries.
+The repository a script to generate the specification based on the TRaSH-Guide data.
 
-### Tier Creator
+### Requirements
 
-A Python script that generates Custom Formats and Regex Patterns from tier data files.
+The scripts utilize UV for easy package management, ensure it's installed by following the [official instructions](https://github.com/astral-sh/uv?tab=readme-ov-file#installation).
 
-**Location**: `/scripts/tierCreator.py`
+Additionally it's expected that you have a local folder with a TRaSH-Guides clone containing the JSON data ([docs/json within the TRaSH-Guides repository](https://github.com/TRaSH-Guides/Guides/tree/master/docs/json)). The script does not pull any data.
 
-**Usage**:
+### Running the script
 
-```bash
-python tierCreator.py <json_file> --resolution <resolution> --type <type> [--dry-run]
+Assuming you're in the root directory of the repository you can now run:
+
+```
+uv run scripts/generate.py /path/to/trash-guides/docs/json .
 ```
 
-**Arguments**:
-
-- `json_file`: Path to a JSON file in `/tiers` containing release group tier data
-- `--resolution`: One of: SD, 720p, 1080p, 2160p
-- `--type`: One of: Quality, Balanced
-- `--dry-run`: Optional flag to preview changes without writing files
-
-**Example**:
-
-```bash
-python tierCreator.py ../tiers/2160p_quality.json --resolution 2160p --type Quality
-```
-
-The script will:
-
-1. Read the tier data from the specified JSON file
-2. Create regex patterns in `/regex_patterns` for any release groups that don't have one
-3. Generate custom formats in `/custom_formats` for each tier
+It will clear any potentially pre-existing output and generate new output based on the provided TRaSH-Guides folder.