bug #385 update to smarty-3.1.28-dev (from Github)

2 files changed, 72 insertions, 6 deletions

diff --git a/include/smarty/README b/include/smarty/README
index bf03403aa..08b397c3f 100644
--- a/include/smarty/README
+++ b/include/smarty/README
@@ -1,4 +1,4 @@
-Smarty 3.1.13
+Smarty 3.x
 
 Author: Monte Ohrt <monte at ohrt dot com >
 Author: Uwe Tews
@@ -120,7 +120,7 @@ $smarty->unregisterObject($object_name)
 $smarty->unregisterFilter($type, $function_name)
 $smarty->unregisterResource($resource_type)
 
-$smarty->compileAllTemplates($extention = '.tpl', $force_compile = false, $time_limit = 0, $max_errors = null)
+$smarty->compileAllTemplates($extension = '.tpl', $force_compile = false, $time_limit = 0, $max_errors = null)
 $smarty->clearCompiledTemplate($resource_name = null, $compile_id = null, $exp_time = null)
 $smarty->testInstall()
 
@@ -460,12 +460,13 @@ included template.
 PLUGINS
 =======
 
-Smarty3 are following the same coding rules as in Smarty2. 
-The only difference is that the template object is passed as additional third parameter.
+Smarty 3 plugins follow the same coding rules as in Smarty 2. 
+The main difference is that the template object is now passed in place of the smarty object. 
+The smarty object can be still be accessed through $template->smarty.
 
-smarty_plugintype_name (array $params, object $smarty, object $template)
+smarty_plugintype_name (array $params, Smarty_Internal_Template $template)
 
-The Smarty 2 plugins are still compatible as long as they do not make use of specific Smarty2 internals.
+The Smarty 2 plugins are still compatible as long as they do not make use of specific Smarty 2 internals.
 
 
 TEMPLATE INHERITANCE:
diff --git a/include/smarty/README.md b/include/smarty/README.md
new file mode 100644
index 000000000..5783eb3e0
--- /dev/null
+++ b/include/smarty/README.md
@@ -0,0 +1,65 @@
+#Smarty 3 template engine
+##Distribution repository
+
+> Smarty 3.1.28 introduces run time template inheritance
+
+> Read the NEW_FEATURES and INHERITANCE_RELEASE_NOTES file for recent extensions to Smarty 3.1 functionality
+
+Smarty versions 3.1.11 or later are now on github and can be installed with Composer.
+
+
+The "smarty/smarty" package will start at libs/....   subfolder.
+
+To get the latest stable version of Smarty 3.1 use
+
+```json
+"require": {
+    "smarty/smarty": "~3.1"
+}
+```
+
+in your composer.json file.
+
+To get the trunk version use
+
+```json
+"require": {
+    "smarty/smarty": "~3.1@dev"
+}
+```
+
+For a specific version use something like
+
+```json
+"require": {
+    "smarty/smarty": "3.1.19"
+}
+```
+
+PHPUnit test can be installed by corresponding composer entries like
+
+```json
+"require": {
+    "smarty/smarty-phpunit": "3.1.19"
+}
+```
+
+Similar applies for the lexer/parser generator
+
+```json
+"require": {
+    "smarty/smarty-lexer": "3.1.19"
+}
+```
+
+Or you could use
+
+```json
+"require": {
+    "smarty/smarty-dev": "3.1.19"
+}
+```
+
+Which is a wrapper to install all 3 packages
+
+Composer can also be used for Smarty2 versions 2.6.24 to 2.6.28