From e96baf933f670b541bb1ccafb3bf5c08dccf91bb Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Wed, 29 Nov 2017 21:15:50 -0500 Subject: [PATCH] Update README --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4b3c888b..60bf58a5 100644 --- a/README.md +++ b/README.md @@ -26,16 +26,16 @@ Filename should be `YourSlug.json`. ### Manifest properties -Key: **required**, *optional*. - -- **slug**: Unique identifier for your plugin. Should never change. Avoid spaces. Prefix with your company or developer name if you plan to release multiple plugins, e.g. "VCV-PulseMatrix". But most importantly, should never change. -- **name**: Human-readable display name for your plugin. May change on a whim. -- **version**: Your plugin's version, using the guidelines at https://github.com/VCVRack/Rack/issues/266. Do not include the "v" prefix. -- *license*: Abbreviation of the license(s) of your plugin. Use "proprietary" if all rights are reserved. -- *homepage*: URL of the landing page of your plugin. Omit if redundant with the source URL. -- *manual*: URL of the manual of your plugin. HTML, PDF, or GitHub readme/wiki are fine. -- *source*: URL of the source code landing page. -- *download*: URL of the compiled binary package. All supported architectures must be merged into one ZIP file. GitHub releases is a good choice for open-source plugins. -- *productId*: VCV store ID for commercial plugins. -- *arch*: List of supported architectures. Defaults to `["win", "mac", "lin"]` if omitted. -- *sha256*: Hex SHA256 string of the binary ZIP file for verifying downloads. Use `sha256sum [FILE]` or `sha256 [FILE]`. +Keys with * are required. + +- **slug**\*: Unique identifier for your plugin. Should never change. Avoid spaces. Prefix with your company or developer name if you plan to release multiple plugins, e.g. "VCV-PulseMatrix". But most importantly, should never change. +- **name**\*: Human-readable display name for your plugin. May change on a whim. +- **version**\*: Your plugin's version, using the guidelines at https://github.com/VCVRack/Rack/issues/266. Do not include the "v" prefix. +- **license**: Abbreviation of the license(s) of your plugin. Use "proprietary" if all rights are reserved. +- **homepage**: URL of the landing page of your plugin. Omit if redundant with the source URL. +- **manual**: URL of the manual of your plugin. HTML, PDF, or GitHub readme/wiki are fine. +- **source**: URL of the source code landing page. +- **download**: URL of the compiled binary package. All supported architectures must be merged into one ZIP file. Must contain a single folder equal to the name of the plugin's slug. GitHub releases is a good choice for open-source plugins. +- **productId**: VCV store ID for commercial plugins. +- **arch**: List of supported architectures. Defaults to `["win", "mac", "lin"]` if omitted. +- **sha256**: Hex SHA256 string of the binary ZIP file for verifying downloads. Use `sha256sum [FILE]` or `sha256 [FILE]`.