Fix docs

CHANGELOG.md

@@ -1,6 +1,5 @@
-# Yii Framework authentication client extension Change Log
+# Yii Framework External Authentication Extension Change Log
 
-1.1.0 under development
------------------------
+## 1.1.0 under development
 
 - Initial release.

README.md

@@ -1,24 +1,17 @@
 <p align="center">
     <a href="https://github.com/yiisoft" target="_blank">
-        <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="80px">
+        <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii">
     </a>
     <a href="https://oauth.net/2/" target="_blank">
-        <img src="https://oauth.net/images/oauth-2-sm.png" height="80px">
+        <img src="https://oauth.net/images/oauth-2-sm.png" height="80px" alt="Oauth">
     </a>
     <a href="https://openid.net/connect/" target="_blank">
-        <img src="https://openid.net/wordpress-content/uploads/2014/09/openid-r-logo-900x360.png" height="80px">
+        <img src="https://openid.net/wordpress-content/uploads/2014/09/openid-r-logo-900x360.png" height="80px" alt="OpenId">
     </a>
     <h1 align="center">Yii Framework External Authentication Extension</h1>
     <br>
 </p>
 
-This extension adds [OAuth](https://oauth.net/), [OAuth2](https://oauth.net/2/) and [OpenId Connect](https://openid.net/connect/)
-consumers for the [Yii framework](https://www.yiiframework.com).
-
-For license information check the [LICENSE](https://github.com/yiisoft/yii-auth-client/blob/master/LICENSE.md)-file.
-
-Documentation is at [docs/guide/README.md](https://github.com/yiisoft/yii-auth-client/blob/master/docs/guide/README.md).
-
 [![Latest Stable Version](https://poser.pugx.org/yiisoft/yii-auth-client/v/stable.png)](https://packagist.org/packages/yiisoft/yii-auth-client)
 [![Total Downloads](https://poser.pugx.org/yiisoft/yii-auth-client/downloads.png)](https://packagist.org/packages/yiisoft/yii-auth-client)
 [![Build status](https://github.com/yiisoft/yii-auth-client/workflows/build/badge.svg)](https://github.com/yiisoft/yii-auth-client/actions?query=workflow%3Abuild)
@@ -28,56 +21,44 @@ Documentation is at [docs/guide/README.md](https://github.com/yiisoft/yii-auth-c
 [![static analysis](https://github.com/yiisoft/yii-auth-client/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/yii-auth-client/actions?query=workflow%3A%22static+analysis%22)
 [![type-coverage](https://shepherd.dev/github/yiisoft/yii-auth-client/coverage.svg)](https://shepherd.dev/github/yiisoft/yii-auth-client)
 
-Installation
-------------
-
-The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
+This extension adds [OAuth](https://oauth.net/), [OAuth2](https://oauth.net/2/) and [OpenId Connect](https://openid.net/connect/)
+consumers for the [Yii framework](https://www.yiiframework.com).
 
-```
-composer require --prefer-dist yiisoft/yii-auth-client
-```
+## Requirements
 
-## General usage
+- PHP 7.4 or higher.
 
-### Unit testing
+## Installation
 
-The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
+The package could be installed with [Composer](https://getcomposer.org):
 
 ```shell
-./vendor/bin/phpunit
+composer require yiisoft/yii-auth-client
 ```
 
-### Mutation testing
+## Documentation
 
-The package tests are checked with [Infection](https://infection.github.io/) mutation framework. To run it:
+- Guide: [English](docs/guide/en/README.md), [Русский](docs/guide/ru/README.md)
+- [Internals](docs/internals.md)
 
-```shell
-./vendor/bin/infection
-```
+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).
 
-### Static analysis
+## License
 
-The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
+The Yii Framework External Authentication Extension is free software. It is released under the terms of the BSD License.
+Please see [`LICENSE`](./LICENSE.md) for more information.
 
-```shell
-./vendor/bin/psalm
-```
+Maintained by [Yii Software](https://www.yiiframework.com/).
 
-### Support the project
+## 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)
 
-### Follow updates
+## Follow updates
 
 [![Official website](https://img.shields.io/badge/Powered_by-Yii_Framework-green.svg?style=flat)](https://www.yiiframework.com/)
 [![Twitter](https://img.shields.io/badge/twitter-follow-1DA1F2?logo=twitter&logoColor=1DA1F2&labelColor=555555?style=flat)](https://twitter.com/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 Framework External Authentication Extension 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/).

UPGRADE.md

@@ -1 +1,6 @@
-# Upgrading Instructions for Yii Framework external authentication via OAuth and OpenID Extension
+# Yii Framework External Authentication Extension Upgrading Instructions
+
+This file contains the upgrade notes. These notes highlight changes that could break your
+application when you upgrade the package from one version to another.
+
+## Changes summary

composer.json

@@ -11,13 +11,23 @@
     "type": "library",
     "license": "BSD-3-Clause",
     "support": {
-        "issues": "https://github.com/yiisoft/yii-auth-client/issues",
+        "issues": "https://github.com/yiisoft/yii-auth-client/issues?state=open",
+        "source": "https://github.com/yiisoft/yii-auth-client",
         "forum": "https://www.yiiframework.com/forum/",
         "wiki": "https://www.yiiframework.com/wiki/",
-        "irc": "irc://irc.freenode.net/yii",
-        "chat": "https://t.me/yii3en",
-        "source": "https://github.com/yiisoft/yii-auth-client"
+        "irc": "ircs://irc.libera.chat:6697/yii",
+        "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|^8.0",
         "psr/http-client": "^1.0",

docs/guide/installation.md → docs/guide/en/installation.md

@@ -6,7 +6,7 @@ Installation
 In order to install extension use Composer. Either run:
 
 ```
-composer require --prefer-dist yiisoft/yii-auth-client "~3.0.0"
+composer require yiisoft/yii-auth-client "~3.0.0"
 ```
 
 or add

docs/guide/open-id-connect.md → docs/guide/en/open-id-connect.md

@@ -32,7 +32,7 @@ for the authentication process securing. You will need to install `spomky-labs/j
 extension by default, in order to use such verification. This can be done via composer:
 
 ```
-composer require --prefer-dist "spomky-labs/jose:~5.0.6"
+composer require "spomky-labs/jose:~5.0.6"
 ```
 
 or add

docs/guide-ru/installation.md → docs/guide/ru/installation.md

@@ -6,7 +6,7 @@
 Для установки расширения используйте Composer. Запустите
 
 ```
-composer require --prefer-dist yiisoft/yii-auth-client "~2.3.0"
+composer require yiisoft/yii-auth-client "~2.3.0"
 ```
 
 или добавьте

docs/internals.md

@@ -0,0 +1,26 @@
+# Internals
+
+## Unit testing
+
+The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
+
+```shell
+./vendor/bin/phpunit
+```
+
+## Mutation testing
+
+The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
+[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
+
+```shell
+./vendor/bin/roave-infection-static-analysis-plugin
+```
+
+## Static analysis
+
+The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
+
+```shell
+./vendor/bin/psalm
+```