mirror of
https://github.com/silverstripe/silverstripe-widgets
synced 2024-10-22 17:05:54 +02:00
Merge pull request #63 from jedateach/docs
Added instructions for releasing a widget
This commit is contained in:
commit
8e1058c8dd
38
README.md
38
README.md
@ -160,6 +160,44 @@ An example widget is below:
|
|||||||
<% end_control %>
|
<% 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
|
## Extending and Customizing
|
||||||
|
|
||||||
### Rendering a $Widget Individually
|
### Rendering a $Widget Individually
|
||||||
|
Loading…
Reference in New Issue
Block a user