Added short documentation regarding package validation tool

wienczny · Feb 22, 2016 · 3861f0f · 3861f0f
1 parent 350a97d
commit 3861f0f
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,3 +2,18 @@
 This repository would is used to house tools for Magento 2. Currently, it only houses a package validation tool for Magento 2 Extensions. In the future, more standalone tools will be added as needed.
 ##Marketplace
 The idea behind this repository is to house standalone tools that developers can use to validate/verify their extensions before submitting them to the Marketplace. Currently, it only houses a package validation tool for Magento 2 Extensions. In the works is a standalone tool that will generate a CodeSniffer report for a given Extension.
+######validate_m2_package.php
+```
+Usage: validate_m2_package [OPTIONS] <M2 zip file> [<M2 zip file> ...]
+
+       -h  help
+           Prints this usage.
+
+       -d debug
+           Optional - prints additional debug messages.
+```
+The tool is silent on success unless the debug option is set. If the tool finds any errors it will report them in the following format to make the errors searchable:
+
+ERROR - "\<zip file name\>": Error message.
+
+Errors must be fixed, warnings and notes are purely informational. The user can fix any warnings or notes but is not required to.