diff --git a/README.md b/README.md index 45ee0c0..73162b9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ # terminal42/contao-webpack-encore + +`terminal42/contao-webpack-encore` is an extension for the [Contao CMS](https://contao.org). + +It allows you to integrate Encore entrypoints into Contao, either through the page layout, +through .html5-Template methods or through insert tags. + +If you use Twig templates, you can use the regular Symfony Encore Bundle features. + + +## Installation + +Choose the installation method that matches your workflow! + +### Installation via Contao Manager + +Search for `terminal42/contao-webpack-encore` in the Contao Manager and add it +to your installation. Apply changes to update the packages. + +### Manual installation + +Add a composer dependency for this bundle. Therefore, change in the project root and run the following: + +```bash +composer require terminal42/contao-webpack-encore +``` + +Depending on your environment, the command can differ, i.e. starting with `php composer.phar …` if you do not have +composer installed globally. + +Then, update the database via the `contao:migrate` command or the Contao install tool. + + +## Configuration + +The Contao Manager Plugin will automatically try to detect an `entrypoints.json` in your public web directory. +If none is found, or you would like to manually configure it, adjust the Symfony `webpack_encore.output_path` +accordingly: https://symfony.com/bundles/WebpackEncoreBundle/current/index.html + +## License + +This bundle is released under the [MIT license](LICENSE) diff --git a/composer.json b/composer.json index a85f5d3..bcf32c5 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "terminal42/contao-webpack-encore", - "description": "Adds Symfony Webpack Encore support to Contao.", + "description": "Adds Symfony Webpack Encore integration to Contao page layouts.", "keywords": ["contao", "symfony", "webpack", "encore"], "homepage": "https://github.com/terminal42/contao-webpack-encore", "type": "contao-bundle", @@ -46,6 +46,13 @@ "Terminal42\\WebpackEncoreBundle\\": "src/" } }, + "config": { + "allow-plugins": { + "contao-components/installer": true, + "contao/manager-plugin": true, + "terminal42/contao-build-tools": true + } + }, "extra": { "contao-manager-plugin": "Terminal42\\WebpackEncoreBundle\\ContaoManager\\Plugin" }