From 6e276ef99abeaec0e41416ca5d1c88af888daa36 Mon Sep 17 00:00:00 2001 From: wandersonwhcr Date: Mon, 1 Dec 2014 14:25:09 -0800 Subject: [PATCH] Docs for Phar Plugin --- Phar-Plugin.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 Phar-Plugin.md diff --git a/Phar-Plugin.md b/Phar-Plugin.md new file mode 100644 index 0000000..938629a --- /dev/null +++ b/Phar-Plugin.md @@ -0,0 +1,18 @@ +Allows you to create a [Phar](http://php.net/manual/en/book.phar.php) archive from your project. + +### Example + +``` +phar: + directory: /path/to/directory + filename: foobar.phar + regexp: /\.(php|phtml)$/ + stub: filestub.php +``` + +### Configuration Options + +* **directory**: `phar` output directory. Default: `%buildpath%`; +* **filename**: `phar` filename inside output directory. Default: `build.phar`; +* **regexp**: regular expression for Phar iterator. Default: `/\.php$/`; and +* **stub**: stub content filename. No default value. \ No newline at end of file