From aa8bf9de4d10d4d7e119ec52d25110b91f3c0308 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Sat, 4 May 2024 10:52:29 -0300 Subject: [PATCH 1/3] Fix docs --- LICENSE.md | 6 +++--- README.md | 26 ++++++++++++-------------- 2 files changed, 15 insertions(+), 17 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 6a920d6..c48bcea 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -5,13 +5,13 @@ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -* Redistributions of source code must retain the above copyright + * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -* Redistributions in binary form must reproduce the above copyright + * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -* Neither the name of Yii Software nor the names of its + * Neither the name of Yii Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/README.md b/README.md index 972b664..8e640fc 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,10 @@ to events dispatched. ## Installation -The package could be installed with composer: +The package could be installed via [composer](https://getcomposer.org/download/) ```shell -composer require yiisoft/event-dispatcher --prefer-dist +composer require yiisoft/event-dispatcher ``` ## General usage @@ -199,14 +199,19 @@ $dispatcher->dispatch(new MyEvent()); - [Internals](docs/internals.md) -## Credits +If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. +You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). -- Larry Garfield (@crell) for initial implementation of deriving callable parameter type. +## License -## Support +The Yii Event Dispatcher is free software. It is released under the terms of the BSD License. +Please see [`LICENSE`](./LICENSE.md) for more information. -If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. -You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). +Maintained by [Yii Software](https://www.yiiframework.com/). + +## Credits + +- Larry Garfield (@crell) for initial implementation of deriving callable parameter type. ## Support the project @@ -219,10 +224,3 @@ You may also check out other [Yii Community Resources](https://www.yiiframework. [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en) [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk) [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack) - -## License - -The Yii Access is free software. It is released under the terms of the BSD License. -Please see [`LICENSE`](./LICENSE.md) for more information. - -Maintained by [Yii Software](https://www.yiiframework.com/). From 45af64afe7d4082f194850dd1928ae197df98385 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Mon, 6 May 2024 07:10:17 -0300 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8e640fc..916dcac 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ to events dispatched. ## Installation -The package could be installed via [composer](https://getcomposer.org/download/) +The package could be installed with [Composer](https://getcomposer.org): ```shell composer require yiisoft/event-dispatcher From baedbfe11777f79837ea6a01d0ba121360687a2c Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Tue, 7 May 2024 20:17:15 +0300 Subject: [PATCH 3/3] fix --- docs/internals.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/internals.md b/docs/internals.md index 8dc4049..087a514 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -25,7 +25,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ./vendor/bin/psalm ``` -## Rector +## Code style Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or use either newest or any specific version of PHP: @@ -34,11 +34,10 @@ use either newest or any specific version of PHP: ./vendor/bin/rector ``` -## Composer require checker +## Dependencies -This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. - -To run the checker, execute the following command: +This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if +all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command: ```shell ./vendor/bin/composer-require-checker