diff --git a/PRG.md b/PRG.md index 757a093..7823b55 100644 --- a/PRG.md +++ b/PRG.md @@ -1,30 +1,44 @@ -# Personal Repisitory Guidelines (PRG) Connection File +
+ + + +
-This repository is catagorized under the **PRG** system. +

Personal Repository Guidelines (PRG) Connection File

+ +This file is used to connect this repository to the **PRG** project categorization system. + +--------------- ## Project Information -Repository Tier: Gold
-Technology: iOS, watchOS, UIKit, Objective-C, Swift, PHP, MySQL
-Category: Mobile Application
-Order: 3
+**Repository Tier:** Gold
+**Technology:** iOS, watchOS, UIKit, Objective-C, Swift, PHP, MySQL
+**Category:** Mobile Application
+**Order:** 3
-## How this works +## Parameters -This file connects this repository to the **PRG** guideline and categorization system. +- **Repository Tier (Required):** Gold, Silver, Bronze, or Optimized (required for PRG - if you don't add a tier it will be displayed as "Optimized" by default) +- **Technologies (Optional):** List the technologies used to build your project here (e.g. Markdown, API, GitHub Actions, Jekyll, Python, DataTables, etc.) +- **Category (Optional):** List categories for your project here (e.g. Web, Mobile, API, etc.) +- **Order (Optional):** By default, repos are ranked by Tier, then Create Date, but you can also add an integer (e.g. 1, 2, 12, etc.) to sort in between Tier and Create Date -> [!NOTE] -> Include this file in your projects root folder for this repo to properly connect to your PRG system. -> Lines 5-8 are mapped in the `scripts/project_tier_table.py` script to the PRG system. Do not move or change these lines. -> Private repositories will not be included in the PRG system. To include a private repository or an external project outside of GitHub, add them to the `categories/project_tier_table_private.md` table manually following the repos that are already in there as a template. +## How this works -## Parameters +This file connects this repository to the **PRG** guideline and categorization system. +- Include this file in your projects root folder for this repo to properly connect to your PRG system. +- To include private repos (if configured to ignore private repos in the script) or an external project outside of GitHub, add them to the `categories/project_tier_table_private.md` table manually following the structure of the table. -- **Repository Tier (Required):** Gold, Silver, or Bronze (required for PRG) -- **Technologies (Optional):** List the technologies used to build your project here (optional) -- **Category (Optional):** List categories for your project here (optional) -- **Order (Optional):** By default, repos are ranked by Tier, then Create Date, but you can also add an integer (1, 2, 12, etc.) to sort in between Tier and Create Date (optional) +> [!CAUTION] +> Lines 7-10 are mapped in the `scripts/project_tier_table.py` script to the PRG system. Do not move or change these lines without adjusting the script to account for this change. ## Visit the PRG Repository Visit the official [Personal Repository Guidelines (PRG)](https://github.com/scottgriv/PRG-Personal-Repository-Guidelines) repository for more details. + +

+ + Optimized + +

\ No newline at end of file