diff --git a/README.md b/README.md index e9ada92..8d08f16 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,13 @@ 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 - -* 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): +## Installation +```sh +composer require silverstripe/widgets ``` -$ 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 @@ -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. @@ -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": [ @@ -234,9 +229,6 @@ You need to finish off / change: "email": "" } ], - "extra" : { - "installer-name": "widgets_" - }, "autoload": { "psr-4": { "Yourname\\MyWidget\\": "src/" @@ -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. diff --git a/composer.json b/composer.json index 05d09f6..3175480 100644 --- a/composer.json +++ b/composer.json @@ -37,4 +37,4 @@ "license": "BSD-3-Clause", "minimum-stability": "dev", "prefer-stable": true -} +} \ No newline at end of file diff --git a/package.json b/package.json index 888542a..2868f8b 100644 --- a/package.json +++ b/package.json @@ -20,11 +20,10 @@ "lint": "eslint client/src && sass-lint client/src", "lint-fix": "eslint client/src --fix && sass-lint client/src --fix" }, - "dependencies": { - }, + "dependencies": {}, "devDependencies": { - "@silverstripe/eslint-config": "^1.0.0-alpha6", - "@silverstripe/webpack-config": "^2.0.0-alpha5", + "@silverstripe/eslint-config": "^1.0.0", + "@silverstripe/webpack-config": "^2.0.0", "webpack": "^5.74.0", "webpack-cli": "^5.0.0" }, diff --git a/yarn.lock b/yarn.lock index b0b5b77..43d227f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1261,10 +1261,10 @@ resolved "https://registry.yarnpkg.com/@sect/modernizr-loader/-/modernizr-loader-1.0.3.tgz#7fd8cec372426c53f113f3cfd9344cb29e959825" integrity sha512-47zKwv4/1I0CYptZz8s4aSYSe0awmuyqa+HFKxN89/75h2q8hr6V752TZ9VjhGDhQ4gU0EU7Plew7b+7bf2crg== -"@silverstripe/eslint-config@^1.0.0-alpha6": - version "1.0.0-alpha6" - resolved "https://registry.yarnpkg.com/@silverstripe/eslint-config/-/eslint-config-1.0.0-alpha6.tgz#1f243b003fddf3503a4abea37f35a8a5968cc96e" - integrity sha512-+P7UzhMRSmc7UlRYCiSXwjauLFYU11oBPwHl/bpacJ7xUcFY3Jt3CgcDt6d+XLvAJO8zMRsG9RcOm5MnxsyCsg== +"@silverstripe/eslint-config@^1.0.0": + version "1.0.0" + resolved "https://registry.yarnpkg.com/@silverstripe/eslint-config/-/eslint-config-1.0.0.tgz#dcf3f9cf2158bb587d8048a7c2860c0513221d40" + integrity sha512-pcHzB+6KWd8BPStBhHM8achdNY/Yj1p3WSTEs/CSw61VRcfBfg5GZECtvEerTSX/0ZeawAM1ABvstIAYihcfAg== dependencies: eslint "^8.26.0" eslint-config-airbnb "^19.0.4" @@ -1274,10 +1274,10 @@ eslint-plugin-react "^7.31.10" eslint-webpack-plugin "^3.2.0" -"@silverstripe/webpack-config@^2.0.0-alpha5": - version "2.0.0-alpha6" - resolved "https://registry.yarnpkg.com/@silverstripe/webpack-config/-/webpack-config-2.0.0-alpha6.tgz#4a781f600344c3604169de08244ca11cacbd46f7" - integrity sha512-cPux01Z6EGwnSg5EezaJZ1S2x4ThfA3TbpTWTsqmW2jvr1VM/7Xu8B3j2HFH+2fNP0dvdmu+fScCD6VPNVQNWw== +"@silverstripe/webpack-config@^2.0.0": + version "2.0.0" + resolved "https://registry.yarnpkg.com/@silverstripe/webpack-config/-/webpack-config-2.0.0.tgz#278a72a1adbc6fa2362497d60424c78fba58e8e1" + integrity sha512-m1qGRxlsdhWL567cWe7IZNBUCzeyg3T1Y9yY9Y6XClwAqlg1oIO9uLfvfauA4dbtECrzU5n1AkaaU6kMRtN6Aw== dependencies: "@babel/core" "^7.19.6" "@babel/preset-env" "^7.19.4"