From fbfb0995d73802af7771c6ffd5a9958771adb30e Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Thu, 16 May 2024 03:53:12 -0300 Subject: [PATCH] Fix docs (#41) Co-authored-by: Sergei Predvoditelev --- CHANGELOG.md | 2 +- LICENSE.md | 6 +++--- README.md | 24 +++++++++++------------- UPGRADE.md | 5 ++--- composer.json | 14 ++++++++++++-- docs/internals.md | 9 --------- 6 files changed, 29 insertions(+), 31 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 503b9d1..f3fada1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# Yii WinCache Change Log +# Yii Cache Library - WinCache Handler Change Log ## 1.0.2 under development 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 5e099c5..5501240 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- + Yii

Yii Cache Library - WinCache Handler


@@ -15,7 +15,7 @@ [![type-coverage](https://shepherd.dev/github/yiisoft/cache-wincache/coverage.svg)](https://shepherd.dev/github/yiisoft/cache-wincache) This package uses the PHP [Windows Cache](https://sourceforge.net/projects/wincache/) -([see also](https://www.php.net/manual/book.wincache.php)) extension and implements +(see also [Windows Cache for PHP](https://www.php.net/manual/book.wincache.php)) extension and implements [PSR-16](https://www.php-fig.org/psr/psr-16/) cache. ## Requirements @@ -25,10 +25,10 @@ This package uses the PHP [Windows Cache](https://sourceforge.net/projects/winca ## Installation -The package could be installed with composer: +The package could be installed with [Composer](https://getcomposer.org): ```shell -composer require yiisoft/cache-wincache --prefer-dist +composer require yiisoft/cache-wincache ``` ## General usage @@ -75,11 +75,16 @@ 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). +## License + +The Yii Cache Library - WinCache Handler 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) @@ -91,10 +96,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 Cache Library - WinCache Handler 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/UPGRADE.md b/UPGRADE.md index 55c757a..ce2f175 100644 --- a/UPGRADE.md +++ b/UPGRADE.md @@ -1,4 +1,3 @@ -Upgrading Instructions -====================== +# Upgrading Instructions -Changes summary: +## Changes summary diff --git a/composer.json b/composer.json index f8c3201..0eb4863 100644 --- a/composer.json +++ b/composer.json @@ -13,12 +13,22 @@ "license": "BSD-3-Clause", "support": { "issues": "https://github.com/yiisoft/cache-wincache/issues?state=open", + "source": "https://github.com/yiisoft/cache-wincache", "forum": "https://www.yiiframework.com/forum/", "wiki": "https://www.yiiframework.com/wiki/", "irc": "ircs://irc.libera.chat:6697/yii", - "chat": "https://t.me/yii3en", - "source": "https://github.com/yiisoft/cache-wincache" + "chat": "https://t.me/yii3en" }, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/yiisoft" + }, + { + "type": "github", + "url": "https://github.com/sponsors/yiisoft" + } + ], "require": { "php": "^7.4", "ext-wincache": "*", diff --git a/docs/internals.md b/docs/internals.md index 3ca962d..b37b5b8 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -24,12 +24,3 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ```shell ./vendor/bin/psalm ``` - -## Rector - -Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or -use either newest or any specific version of PHP: - -```shell -./vendor/bin/rector -```