diff --git a/library/README.md b/library/README.md index de8cf28..e8e308b 100644 --- a/library/README.md +++ b/library/README.md @@ -10,6 +10,8 @@ Each rule is identified by a unique integer ID. All data in a rule set should be - `rule-set.json` - `metadata.json` +- Image files (optional) +- Video files (optional) Folders of deleted rule sets remain like `8_DELETED`, ensuring that IDs remain unique. @@ -56,38 +58,34 @@ This file contains metadata of a rule set. ```json { - "authors": [ - { - "name": "Author Name 1", - "gitHubID": "author-github-id1" - }, - { - "name": "Author Name 2", - "gitHubID": "author-github-id2", - } + "authorGitHubId": "", + "imageFiles": [ + "image.png" ], - "imageURLs": [ - "https://somewhere-on-the-internet.com/path/to/your-rule-set-image.jpg" + "videoFiles": [ + "video.mp4" ], - "aboutURL": "https://somewhere-on-the-internet.com/path/to/the-rule-set-details.html", - "title": "A title of the rule set", - "description": "A description of the rule set.", - "version": "1.0.0", - "primaryCategoryID": "gaming", - "secondaryCategoryID": "productivity" + "aboutURL": "", + "title": "", + "description": "", + "primaryCategoryId": "gaming", + "secondaryCategoryId": "productivity" } ``` -- `authors`: A list of rule set's authors. - - `name`: The name of an author. - - `gitHubID`: The GitHub ID of an author. -- `imageURLs` (optional): A list of image URLs of the rule set. -- `videoURLs` (optional): A list of video URLs for the rule set, including: - - A direct link to a video file that QuickTime Player can play, or, - - A YouTube video URL. +- `authorGitHubId`: An author's GitHub ID. - `aboutURL` (optional): A link to a webpage where users can learn more about the rule set. - `title`: A short title of the rule set. - `description`: A description of the rule set. This is optional when the first rule in the rule set has non-empty `comments`. -- `version`: A version of the rule set, which should follow [Semantic Versioning](https://semver.org). -- `primaryCategoryID`: A primary category ID of the rule set. Find a list of the categories in [categories.json](./categories.json). -- `secondaryCategoryID` (optional): A secondary category ID of the rule set. +- `primaryCategoryId`: A primary category ID of the rule set. Find a list of the categories in [categories.json](./categories.json). +- `secondaryCategoryId` (optional): A secondary category ID of the rule set. + +## Image files (optional) + +Images of the rule set. +PNG and JPEG images are supported. + +## Video files (optional) + +A list of video URLs for the rule set. +Video formats that QuickTime Player can play are supported. diff --git a/library/rule-sets/0_example-rule/metadata.json b/library/rule-sets/0_example-rule/metadata.json index 7c8a878..ba7952a 100644 --- a/library/rule-sets/0_example-rule/metadata.json +++ b/library/rule-sets/0_example-rule/metadata.json @@ -1,15 +1,8 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": null, + "authorGitHubId": "mshibanami", "aboutURL": null, "title": "Example Redirect Rule", "description": "An example rule.", "version": "1.0.0", - "primaryCategoryID": "other" + "primaryCategoryId": "other" } diff --git a/library/rule-sets/1_google-meet-open-in-chrome/metadata.json b/library/rule-sets/1_google-meet-open-in-chrome/metadata.json index 20c2893..6b0eadd 100644 --- a/library/rule-sets/1_google-meet-open-in-chrome/metadata.json +++ b/library/rule-sets/1_google-meet-open-in-chrome/metadata.json @@ -1,16 +1,9 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": null, + "authorGitHubId": "mshibanami", "aboutURL": null, "title": "Google Meet: Open in Chrome", "description": "A rule to open Google Meet links in Google Chrome automatically.", "version": "1.0.0", - "primaryCategoryID": "productivity", - "secondaryCategoryID": "business" + "primaryCategoryId": "productivity", + "secondaryCategoryId": "business" } diff --git a/library/rule-sets/2_notion-open-in-notion-app/metadata.json b/library/rule-sets/2_notion-open-in-notion-app/metadata.json index 427a422..1f98886 100644 --- a/library/rule-sets/2_notion-open-in-notion-app/metadata.json +++ b/library/rule-sets/2_notion-open-in-notion-app/metadata.json @@ -1,15 +1,8 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": null, + "authorGitHubId": "mshibanami", "aboutURL": null, "title": "Notion: Open in Notion App", "description": "A rule to open Notion links in the Notion app automatically.", "version": "1.0.0", - "primaryCategoryID": "productivity" + "primaryCategoryId": "productivity" } diff --git a/library/rule-sets/3_wikipedia-open-in-wikiwand/metadata.json b/library/rule-sets/3_wikipedia-open-in-wikiwand/metadata.json index d270efb..2f24cd5 100644 --- a/library/rule-sets/3_wikipedia-open-in-wikiwand/metadata.json +++ b/library/rule-sets/3_wikipedia-open-in-wikiwand/metadata.json @@ -1,15 +1,8 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": null, + "authorGitHubId": "mshibanami", "aboutURL": null, "title": "Wikipedia: Open in Wikiwand", "description": "Open Wikipedia pages in Wikiwand automatically.", "version": "1.0.0", - "primaryCategoryID": "reference" + "primaryCategoryId": "reference" } diff --git a/library/rule-sets/4_github-hide-whitespace-changes-in-pull-request/metadata.json b/library/rule-sets/4_github-hide-whitespace-changes-in-pull-request/metadata.json index b8e613a..68d620f 100644 --- a/library/rule-sets/4_github-hide-whitespace-changes-in-pull-request/metadata.json +++ b/library/rule-sets/4_github-hide-whitespace-changes-in-pull-request/metadata.json @@ -1,15 +1,8 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": null, + "authorGitHubId": "mshibanami", "aboutURL": null, "title": "GitHub: Ignore Whitespace Changes in a Pull Request", "description": "This hides whitespace changes in a pull request on GitHub automatically.", "version": "1.0.0", - "primaryCategoryID": "software_development" + "primaryCategoryId": "software_development" } diff --git a/library/rule-sets/5_figma-open-in-figma-app/metadata.json b/library/rule-sets/5_figma-open-in-figma-app/metadata.json index 3225d46..0ab4539 100644 --- a/library/rule-sets/5_figma-open-in-figma-app/metadata.json +++ b/library/rule-sets/5_figma-open-in-figma-app/metadata.json @@ -1,15 +1,8 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": null, + "authorGitHubId": "mshibanami", "aboutURL": null, "title": "Figma: Open in Figma App", "description": "Open Figma links in the Figma app automatically.", "version": "1.0.0", - "primaryCategoryID": "arts_and_crafts" + "primaryCategoryId": "arts_and_crafts" } diff --git a/library/rule-sets/6_redirect-from-google-search-to-youtube/metadata.json b/library/rule-sets/6_redirect-from-google-search-to-youtube/metadata.json index d42127f..1c367c5 100644 --- a/library/rule-sets/6_redirect-from-google-search-to-youtube/metadata.json +++ b/library/rule-sets/6_redirect-from-google-search-to-youtube/metadata.json @@ -1,17 +1,8 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": [ - "https://private-user-images.githubusercontent.com/1333214/241560627-ef8abf48-fa9d-4bb4-9298-7e78cde5e5d9.mov?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTAwNTEzNTAsIm5iZiI6MTcxMDA1MTA1MCwicGF0aCI6Ii8xMzMzMjE0LzI0MTU2MDYyNy1lZjhhYmY0OC1mYTlkLTRiYjQtOTI5OC03ZTc4Y2RlNWU1ZDkubW92P1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDMxMCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDAzMTBUMDYxMDUwWiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NGI1MDJiZTc5NzkzYzQ4OWJlMzg5YTcyNjUzMDA3MzU0ODZlZTY3YzU3ZjA2NTZlNjNjNzY5Y2MzMmIxOGI5MiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.cDgH4bPIqDqoze6_v39IFXEA-OhACgheG_VYvF4n6t4" - ], + "authorGitHubId": "mshibanami", "aboutURL": null, "title": "Google Search: From Video Tab to YouTube's Search Results", "description": "This redirects from the Videos tab on Google Search to the search results on YouTube automatically.", "version": "1.0.0", - "primaryCategoryID": "search" + "primaryCategoryId": "search" } diff --git a/library/rule-sets/7_minecraft-fandom-wiki-to-mincraft-wiki/metadata.json b/library/rule-sets/7_minecraft-fandom-wiki-to-mincraft-wiki/metadata.json index c3aa7bb..c6c27df 100644 --- a/library/rule-sets/7_minecraft-fandom-wiki-to-mincraft-wiki/metadata.json +++ b/library/rule-sets/7_minecraft-fandom-wiki-to-mincraft-wiki/metadata.json @@ -1,15 +1,10 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": null, + "authorGitHubId": "mshibanami", + "imageFiles": null, + "videoFiles": null, "aboutURL": null, "title": "Minecraft Wiki: From Fandom to minecraft.wiki", "description": "This redirects from Minecraft Wiki on Fandom to the new domain at minecraft.wiki.", "version": "1.0.0", - "primaryCategoryID": "gaming" + "primaryCategoryId": "gaming" } diff --git a/library/rule-sets/9_terraria-fandom-wiki-to-wiki-gg/metadata.json b/library/rule-sets/9_terraria-fandom-wiki-to-wiki-gg/metadata.json index f44e10f..75e299d 100644 --- a/library/rule-sets/9_terraria-fandom-wiki-to-wiki-gg/metadata.json +++ b/library/rule-sets/9_terraria-fandom-wiki-to-wiki-gg/metadata.json @@ -1,15 +1,8 @@ { - "authors": [ - { - "name": "Manabu Nakazawa", - "gitHubID": "mshibanami" - } - ], - "imageURLs": null, - "videoURLs": null, + "authorGitHubId": "mshibanami", "aboutURL": null, "title": "Terraria Wiki: From Fandom to wiki.gg", "description": "This redirects from Terraria Wiki on Fandom to the new domain at wiki.gg.", "version": "1.0.0", - "primaryCategoryID": "gaming" + "primaryCategoryId": "gaming" }