Skip to content

Commit

Permalink
Merge pull request #200 from creative-commoners/pulls/3.0/cms5-readme
Browse files Browse the repository at this point in the history
DOC Update README.md for CMS 5
  • Loading branch information
sabina-talipova authored Apr 25, 2023
2 parents 1eb8622 + 7e6ee59 commit 0e86c1c
Showing 1 changed file with 12 additions and 20 deletions.
32 changes: 12 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,14 @@
Widgets are small pieces of functionality such as showing the latest comments or Flickr photos. They normally display on
the sidebar of your website.

## Requirements
## Installation

* Silverstripe 4.0

**Note:** this version is compatible with Silverstripe 4. For Silverstripe 3, please see [the 1.x release line](https://github.com/silverstripe/silverstripe-widgets/tree/1.3).

### Installation

Install the module through [composer](http://getcomposer.org):

```
$ composer require silverstripe/widgets
```sh
composer require silverstripe/widgets
```

## Setup

Widgets are essentially database relations to other models, mostly page types.
By default, they're not added to any of your own models. The easiest and most common
way to get started would be to create a single collection of widgets under the
Expand Down Expand Up @@ -204,7 +198,7 @@ class FlickrWidget extends Widget
## Releasing a widget
Follow the [standard procedures defined for releasing a Silverstripe module](https://docs.silverstripe.org/en/4/developer_guides/extending/how_tos/publish_a_module).
Follow the [standard procedures defined for releasing a Silverstripe module](https://docs.silverstripe.org/en/developer_guides/extending/how_tos/publish_a_module).
Here is a composer template you can use.
Expand All @@ -215,17 +209,18 @@ You need to finish off / change:
* keywords
* license
* author
* installer-name (eg: `widgets_carousel`)
```json
{
"name": "",
"description": "",
"type": "silverstripe-module",
"keywords" : ["widget"],
"keywords" : [
"widget"
],
"require": {
"silverstripe/framework": "^4.0",
"silverstripe/cms": "^4.0"
"silverstripe/framework": "^5.0",
"silverstripe/cms": "^5.0"
},
"license": "BSD-2-Clause",
"authors": [
Expand All @@ -234,9 +229,6 @@ You need to finish off / change:
"email": ""
}
],
"extra" : {
"installer-name": "widgets_"
},
"autoload": {
"psr-4": {
"Yourname\\MyWidget\\": "src/"
Expand Down Expand Up @@ -423,4 +415,4 @@ and any new translations will be merged back to the project source code.
Please use [https://www.transifex.com/projects/p/silverstripe-widgets/](https://www.transifex.com/projects/p/silverstripe-widgets/) to contribute translations,
rather than sending pull requests with YAML files.

See the ["i18n" topic](https://docs.silverstripe.org/en/4/developer_guides/i18n/) on doc.silverstripe.org for more details.
See the ["i18n" topic](https://docs.silverstripe.org/en/developer_guides/i18n/) on docs.silverstripe.org for more details.

0 comments on commit 0e86c1c

Please sign in to comment.