Chore: package improvements

OleksiiBulba · OleksiiBulba · commit 29ccc371a72e · 2022-12-19T11:06:05.000+03:00
- Renamed LICENSE file to LICENSE.md;
- Added scripts to composer.json;
- Improved README.md;

Signed-off-by: Oleksii Bulba &lt;oleksii_bulba@epam.com&gt;
diff --git a/LICENSE.md b/LICENSE.md
diff --git a/README.md b/README.md
@@ -1,23 +1,64 @@
 # Webpack-Encore plugin for Micro framework
 
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE.md)
+[![Total Downloads][ico-downloads]][link-downloads]
+
 This plugin adds several twig functions that help to include script and style html tags to twig templates from webpack-encore entries.
 
 ## Get started
 
 Before starting to work with the plugin, all you need is:
-* Project based on [Micro Framework](https://github.com/Micro-PHP/skeleton);
-* [@symfony/webpack-encore](https://www.npmjs.com/package/@symfony/webpack-encore) installed by npm or yarn;
-* Run composer command `composer require oleksiibulba/webpack-encore-plugin`;
-* Add `\Boo\WebpackEncorePlugin\WebpackEncorePlugin` to your plugins list;
+* Project based on [Micro Framework][link-microframework];
+* [@symfony/webpack-encore][link-symfony-webpack-encore] installed by npm or yarn;
+
+### Install
+
+  You can install the plugin via composer:
+```bash
+composer require oleksiibulba/webpack-encore-plugin
+```
+
+### Usage
+
+Add `OleksiiBulba\WebpackEncorePlugin\WebpackEncorePlugin` to your plugins list:
+```php
+<?php /* ./etc/plugins.php */
 
-## Usage
+return [
+    // List of plugins:
+    // ...
+    OleksiiBulba\WebpackEncorePlugin\WebpackEncorePlugin::class,
+    // ...
+];
+```
+
+To use the plugin you need to create an entrypoint in your webpack.config.js:
+```javascript
+/* ./webpack.config.js */
+const Encore = require('@symfony/webpack-encore');
+Encore
+    /* ... */
+    .addEntry('your_entry_name', './path/to/your_entry_file.jsx')
+    /* ... */
+```
+
+run build:
+```bash
+yarn dev
+// or
+npm dev
+```
 
-To use the plugin you need to create an entrypoint in your webpack.config.js, run build, and add one of the twig functions to a template:
+and add one of the twig functions to a template:
 ```html
+{# ./templates/base.html.twig #}
+{# ... #}
 <head>
     {{ encore_entry_script_tags('your_entry_name') }}
     {{ encore_entry_link_tags('your_entry_name') }}
 </head>
+{# ... #}
 ```
 
 Here is the signature of the twig functions:
@@ -29,7 +70,7 @@ Here is the signature of the twig functions:
 
 If two or more entries contain common files, then they will be printed only once;
 
-### Extra attributes
+#### Extra attributes
 To add extra attribute to the tags, you can pass them in the array as a second argument, like this:
 ```html
 <head>
@@ -43,17 +84,53 @@ and as a result, it will print next html (assuming your entrypoint 'app' contain
 </head>
 ```
 
+## Change Log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Testing
+
+```bash
+composer test
+```
+
 ## Contributing
 
 Please feel free to open pull request or create an issue, they are more than welcome!
 
-## Authors
+## Security
+
+If you discover any security related issues, please email oleksii_bulba@epam.com instead of using the issue tracker.
+
+## Credits
+
+- [Oleksii Bulba][link-author]
+- [Fabien Potencier][email-fabien]
+- [All Contributors][link-contributors]
 
 The code was taken and adapted from `symfony/webpack-encore-bundle` that was created by [Symfony Community](https://symfony.com/contributors) and [Fabien Potencier](mailto:fabien@symfony.com) in particular.
-Adapted for Micro framework plugin by Oleksii Bulba.
+Adapted for Micro framework plugin by [Oleksii Bulba][link-author].
 
-For the full copyright and license information, please view the LICENSE file that was distributed with this source code.
+For the full copyright and license information, please see the [License File](LICENSE.md) that was distributed with this source code.
 
 ## License
 
-[MIT](https://opensource.org/licenses/MIT)
+[The MIT License (MIT)][link-license]. Please see [License File](LICENSE.md) for more information.
+
+[ico-version]: https://img.shields.io/packagist/v/oleksiibulba/webpack-encore-plugin.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/oleksiibulba/webpack-encore-plugin.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/oleksiibulba/webpack-encore-plugin.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/oleksiibulba/webpack-encore-plugin.svg?style=flat-square
+
+[link-microframework]: https://github.com/Micro-PHP/skeleton
+[link-symfony-webpack-encore]: https://www.npmjs.com/package/@symfony/webpack-encore
+[link-packagist]: https://packagist.org/packages/oleksiibulba/webpack-encore-plugin
+[link-travis]: https://travis-ci.org/oleksiibulba/webpack-encore-plugin
+[link-scrutinizer]: https://scrutinizer-ci.com/g/oleksiibulba/webpack-encore-plugin/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/oleksiibulba/webpack-encore-plugin
+[link-downloads]: https://packagist.org/packages/oleksiibulba/webpack-encore-plugin
+[link-author]: https://github.com/OleksiiBulba
+[link-contributors]: ../../contributors
+[link-license]: https://opensource.org/licenses/MIT
+[email-fabien]: mailto:fabien@symfony.com
diff --git a/composer.json b/composer.json
@@ -7,7 +7,9 @@
     "authors": [
         {
             "name": "Oleksii Bulba",
-            "email": "oleksii.bulba@gmail.com"
+            "email": "oleksii.bulba@gmail.com",
+            "homepage": "https://github.com/OleksiiBulba",
+            "role": "Developer"
         }
     ],
     "require": {
@@ -43,5 +45,11 @@
             "name": "symfony/webpack-encore-bundle",
             "url": "https://github.com/symfony/webpack-encore-bundle"
         }
+    },
+    "scripts": {
+        "php-cs-fix": "./vendor/bin/php-cs-fixer fix --verbose --using-cache=no",
+        "php-cs-try": "./vendor/bin/php-cs-fixer fix --verbose --dry-run --using-cache=no",
+        "phpstan": "./vendor/bin/phpstan analyze --no-progress",
+        "phpunit": "./vendor/bin/phpunit"
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,9 @@`
`7`	`7`	`"authors": [`
`8`	`8`	`{`
`9`	`9`	`"name": "Oleksii Bulba",`
`10`		`- "email": "[email protected]"`
	`10`	`+ "email": "[email protected]",`
	`11`	`+ "homepage": "https://github.com/OleksiiBulba",`
	`12`	`+ "role": "Developer"`
`11`	`13`	`}`
`12`	`14`	`],`
`13`	`15`	`"require": {`
`@@ -43,5 +45,11 @@`
`43`	`45`	`"name": "symfony/webpack-encore-bundle",`
`44`	`46`	`"url": "https://github.com/symfony/webpack-encore-bundle"`
`45`	`47`	`}`
	`48`	`+ },`
	`49`	`+ "scripts": {`
	`50`	`+ "php-cs-fix": "./vendor/bin/php-cs-fixer fix --verbose --using-cache=no",`
	`51`	`+ "php-cs-try": "./vendor/bin/php-cs-fixer fix --verbose --dry-run --using-cache=no",`
	`52`	`+ "phpstan": "./vendor/bin/phpstan analyze --no-progress",`
	`53`	`+ "phpunit": "./vendor/bin/phpunit"`
`46`	`54`	`}`
`47`	`55`	`}`