diff vendor/roundcube/plugin-installer/README.md @ 0:1e000243b222

vanilla 1.3.3 distro, I hope
author Charlie Root
date Thu, 04 Jan 2018 15:50:29 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/vendor/roundcube/plugin-installer/README.md	Thu Jan 04 15:50:29 2018 -0500
@@ -0,0 +1,46 @@
+# Plugin Installer for Roundcube
+
+This installer ensures that plugins end up in the correct directory:
+
+ * `<roundcube-root>/plugins/plugin-name`
+
+## Minimum setup
+
+ * create a `composer.json` file in your plugin's repository
+ * add the following contents
+
+### sample composer.json for plugins
+
+    {
+        "name": "yourvendor/plugin-name",
+        "license": "the license",
+        "description": "tell the world what your plugin is good at",
+        "type": "roundcube-plugin",
+        "authors": [
+            {
+                "name": "<your-name>",
+                "email": "<your-email>"
+            }
+        ],
+        "repositories": [
+            {
+                "type": "composer",
+                "url": "http://plugins.roundcube.net"
+            }
+        ]
+        "require": {
+            "roundcube/plugin-installer": "*"
+        },
+        "minimum-stability": "dev-master"
+    }
+
+  * Submit your plugin to [plugins.roundcube.net](http://plugins.roundcube.net).
+
+## Installation
+
+ * clone Roundcube
+ * `cp composer.json-dist composer.json`
+ * add your plugin in the `require` section of composer.json
+ * `composer.phar install`
+
+Read the whole story at [plugins.roundcube.net](http://plugins.roundcube.net/about).