From 156a10b8383512eaf999b558ba329f1f1833f953 Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Tue, 27 Mar 2018 15:08:26 -0400 Subject: [PATCH] Replace websiteUrl with pluginUrl --- README.md | 24 +++++------------------- manifests/AudibleInstruments.json | 2 +- manifests/Befaco.json | 2 +- manifests/ESeries.json | 2 +- manifests/Fundamental.json | 2 +- manifests/VCV-Console.json | 2 +- manifests/VCV-PulseMatrix.json | 2 +- manifests/VCV-Router.json | 2 +- 8 files changed, 12 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 2aab1246..24226e23 100644 --- a/README.md +++ b/README.md @@ -15,32 +15,18 @@ Tasks: - Handle issues opened by plugin developers who want to add/update their plugin. - Seek new plugins/updates when developers don't notify us. -#### Manifest example - -Filename should be `YourSlug.json`. - -```json -{ - "name": "Fundamental", - "author": "VCV", - "license": "BSD-3-Clause", - "contactEmail": "contact@vcvrack.com", - "websiteUrl": "https://vcvrack.com/Fundamental.html", - "manualUrl": "https://vcvrack.com/Fundamental.html#manual", - "sourceUrl": "https://github.com/VCVRack/Fundamental", - "latestVersion": "0.6.0", -} -``` +#### Manifest -#### Manifest properties +The filename of each manifest should be `YourSlug.json`. +See [Fundamental.json](manifests/Fundamental.json) for an example. -All properties are optional. +All properties are optional. URLs should not be redundant across different keys, meaning you must choose the most relevant key for a particular URL. - **name**: Human-readable display name for your plugin. You can change this on a whim, unlike slugs. - **author**: Your name, company, alias, or GitHub username. - **license**: The license type of your plugin. Use "proprietary" if all rights are reserved. If your license is in the [SPDX license list](https://spdx.org/licenses/), use its abbreviation in the "Identifier" column. - **contactEmail**: Your email address for support inquiries. -- **websiteUrl**: Homepage featuring the plugin itself. +- **pluginUrl**: Homepage featuring the plugin itself. - **authorUrl**: Homepage of the author. - **manualUrl**: The manual of your plugin. HTML, PDF, or GitHub readme/wiki are fine. - **sourceUrl**: The source code homepage. E.g. GitHub repo. diff --git a/manifests/AudibleInstruments.json b/manifests/AudibleInstruments.json index bf1cddb8..b1a4e533 100644 --- a/manifests/AudibleInstruments.json +++ b/manifests/AudibleInstruments.json @@ -2,7 +2,7 @@ "name": "Audible Instruments", "author": "VCV", "license": "BSD-3-Clause", - "homepageUrl": "https://vcvrack.com/AudibleInstruments.html", + "pluginUrl": "https://vcvrack.com/AudibleInstruments.html", "authorUrl": "https://vcvrack.com/", "manualUrl": "https://vcvrack.com/AudibleInstruments.html#manual", "sourceUrl": "https://github.com/VCVRack/AudibleInstruments", diff --git a/manifests/Befaco.json b/manifests/Befaco.json index 208ac349..5136c99a 100644 --- a/manifests/Befaco.json +++ b/manifests/Befaco.json @@ -2,7 +2,7 @@ "name": "Befaco", "author": "VCV", "license": "BSD-3-Clause", - "homepageUrl": "https://vcvrack.com/Befaco.html", + "pluginUrl": "https://vcvrack.com/Befaco.html", "authorUrl": "https://vcvrack.com/", "manualUrl": "https://vcvrack.com/Befaco.html#manual", "sourceUrl": "https://github.com/VCVRack/Befaco", diff --git a/manifests/ESeries.json b/manifests/ESeries.json index 7f712ff9..85fc080d 100644 --- a/manifests/ESeries.json +++ b/manifests/ESeries.json @@ -2,7 +2,7 @@ "name": "E-Series", "author": "VCV", "license": "BSD-3-Clause", - "homepageUrl": "https://vcvrack.com/ESeries.html", + "pluginUrl": "https://vcvrack.com/ESeries.html", "authorUrl": "https://vcvrack.com/", "manualUrl": "https://vcvrack.com/ESeries.html#manual", "sourceUrl": "https://github.com/VCVRack/ESeries", diff --git a/manifests/Fundamental.json b/manifests/Fundamental.json index eac997ab..0dd70866 100644 --- a/manifests/Fundamental.json +++ b/manifests/Fundamental.json @@ -2,7 +2,7 @@ "name": "Fundamental", "author": "VCV", "license": "BSD-3-Clause", - "homepageUrl": "https://vcvrack.com/Fundamental.html", + "pluginUrl": "https://vcvrack.com/Fundamental.html", "authorUrl": "https://vcvrack.com/", "manualUrl": "https://vcvrack.com/Fundamental.html#manual", "sourceUrl": "https://github.com/VCVRack/Fundamental", diff --git a/manifests/VCV-Console.json b/manifests/VCV-Console.json index f7642cf4..86138ca6 100644 --- a/manifests/VCV-Console.json +++ b/manifests/VCV-Console.json @@ -2,7 +2,7 @@ "name": "Console", "author": "VCV", "license": "proprietary", - "homepageUrl": "https://vcvrack.com/Console.html", + "pluginUrl": "https://vcvrack.com/Console.html", "authorUrl": "https://vcvrack.com/", "manualUrl": "https://vcvrack.com/Console.html#manual", "latestVersion": "0.5.0", diff --git a/manifests/VCV-PulseMatrix.json b/manifests/VCV-PulseMatrix.json index 0b0e6701..0b772c21 100644 --- a/manifests/VCV-PulseMatrix.json +++ b/manifests/VCV-PulseMatrix.json @@ -2,7 +2,7 @@ "name": "Pulse Matrix", "author": "VCV", "license": "proprietary", - "homepageUrl": "https://vcvrack.com/PulseMatrix.html", + "pluginUrl": "https://vcvrack.com/PulseMatrix.html", "authorUrl": "https://vcvrack.com/", "manualUrl": "https://vcvrack.com/PulseMatrix.html#manual", "latestVersion": "0.5.1", diff --git a/manifests/VCV-Router.json b/manifests/VCV-Router.json index 6df286e6..9170d6c1 100644 --- a/manifests/VCV-Router.json +++ b/manifests/VCV-Router.json @@ -2,7 +2,7 @@ "name": "Router", "author": "VCV", "license": "proprietary", - "homepageUrl": "https://vcvrack.com/Router.html", + "pluginUrl": "https://vcvrack.com/Router.html", "authorUrl": "https://vcvrack.com/", "manualUrl": "https://vcvrack.com/Router.html#manual", "latestVersion": "0.5.0",