From 26260b37103b99114c89b0bca76ba39fc4156ea1 Mon Sep 17 00:00:00 2001 From: Sergei Predvoditelev Date: Fri, 26 Apr 2024 13:55:22 +0300 Subject: [PATCH] Fix docs (#37) --- LICENSE.md | 12 ++++++------ README.md | 8 +++----- docs/internals.md | 2 +- 3 files changed, 10 insertions(+), 12 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index fc0fd72..9794717 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 7bcbfa0..e83cd95 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ centralized thick application (e.g. one server, no dedicated load balancers, etc The package could be installed with composer: ```shell -composer require yiisoft/cache-apcu --prefer-dist +composer require yiisoft/cache-apcu ``` ## General usage @@ -78,10 +78,8 @@ This package can be used as a cache handler for the [Yii Caching Library](https: - [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). ## Support the project diff --git a/docs/internals.md b/docs/internals.md index 3ca962d..5848931 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: