From f03146e6faf452d864c7aa2a0f1c94258be1dfae Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Wed, 8 May 2024 07:11:52 -0300 Subject: [PATCH 1/2] Fix docs --- LICENSE.md | 6 +++--- README.md | 25 ++++++++----------------- 2 files changed, 11 insertions(+), 20 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 6a920d60..c48bcea7 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 ad9abb1e..a2ab8c88 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Yii Console package provides a console that could be added to an application. Th ## Installation -The package could be installed with composer: +The package could be installed with [Composer](https://getcomposer.org): ```shell composer require yiisoft/yii-console @@ -46,18 +46,11 @@ In case you use one of Yii 3 standard application templates, console could be ac If not, then in the simplest use case in your console entry script do the following: ```php -#!/usr/bin/env php -setCommandLoader(new CommandLoader( @@ -155,11 +148,16 @@ Alternatively, you can pass the settings through the console options. To see the - [Internals](docs/internals.md) -## Support - 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). +## License + +The Yii Console 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/). + ## Support the project [![Open Collective](https://img.shields.io/badge/Open%20Collective-sponsor-7eadf1?logo=open%20collective&logoColor=7eadf1&labelColor=555555)](https://opencollective.com/yiisoft) @@ -171,10 +169,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 Console 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 1bd447d1e0e90f166d24573a570a07b7b1cce90e Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Wed, 15 May 2024 10:59:01 +0300 Subject: [PATCH 2/2] fix --- README.md | 7 +++++++ docs/internals.md | 5 ++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a2ab8c88..993c6989 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,18 @@ In case you use one of Yii 3 standard application templates, console could be ac If not, then in the simplest use case in your console entry script do the following: ```php +#!/usr/bin/env php +setCommandLoader(new CommandLoader( diff --git a/docs/internals.md b/docs/internals.md index f2b7b5ef..087a514a 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -36,9 +36,8 @@ use either newest or any specific version of PHP: ## 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