From cccba4dcf49c5acf3b365e58b6433fa0fca0a6ef Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Sat, 27 Apr 2024 16:20:15 +0300 Subject: [PATCH] Fix docs --- LICENSE.md | 12 ++++++------ README.md | 18 ++++++++---------- docs/internals.md | 9 ++++----- 3 files changed, 18 insertions(+), 21 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 6a920d6..fa6ef0f 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -6,14 +6,14 @@ modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. + notice, this list of conditions and the following disclaimer. * 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. + 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 - contributors may be used to endorse or promote products derived - from this software without specific prior written permission. + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT diff --git a/README.md b/README.md index 6a4bc63..225b19a 100644 --- a/README.md +++ b/README.md @@ -153,10 +153,15 @@ Takes only one argument with type of`Yiisoft\Data\Reader\Filter\FilterInterface` - [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). -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 Data DB 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 @@ -169,10 +174,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 Data DB 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/). diff --git a/docs/internals.md b/docs/internals.md index 8dc4049..0a0a1cd 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