From 53a27c77bfe5bd975eb6cee93755117a99a33fa0 Mon Sep 17 00:00:00 2001 From: Jeremy Shipman Date: Wed, 24 Jul 2013 14:01:23 +1200 Subject: [PATCH] Added instructions for releasing a widget --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 1dfbef5..bf4269a 100644 --- a/README.md +++ b/README.md @@ -160,6 +160,44 @@ An example widget is below: <% end_control %> +## Releasing a widget + +Follow the [standard procedures defined for releasing a SilverStripe module](http://doc.silverstripe.org/framework/en/3.1/topics/module-development). + +Here is a composer template you can use. + +You need to finish off / change: + + * name (eg: `yourorganisation/silverstripe-widget-carousel`) + * description + * keywords + * license + * author + * installer-name (eg: `widgets_carousel`) + +```json +{ + "name": "", + "description": "", + "type": "silverstripe-module", + "keywords" : ["widget"], + "require": { + "silverstripe/framework": "3.*", + "silverstripe/cms": "3.*" + }, + "license": "BSD-2-Clause", + "authors": [ + { + "name": "", + "email": "" + } + ], + "extra" : { + "installer-name": "widgets_" + } +} +``` + ## Extending and Customizing ### Rendering a $Widget Individually