From c4c3f733adcc9b5d8bd46d9e4c52c5aa51175d2a Mon Sep 17 00:00:00 2001
From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com>
Date: Sat, 18 May 2024 01:27:49 -0300
Subject: [PATCH] Fix docs (#149)

Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>
---
 CHANGELOG.md      |  2 +-
 README.md         | 32 ++++++--------------------------
 docs/internals.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 51 insertions(+), 27 deletions(-)
 create mode 100644 docs/internals.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d363388..5b2efe0 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,4 +1,4 @@
-# Yii Router FastRoute adapter Change Log
+# Yii Router FastRoute Adapter Change Log
 
 ## 3.1.1 under development
 
diff --git a/README.md b/README.md
index 078bd7b..fb900d4 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
     <a href="https://github.com/yiisoft" target="_blank">
         <img src="https://avatars0.githubusercontent.com/u/993323" height="100px">
     </a>
-    <h1 align="center">Yii Router FastRoute adapter</h1>
+    <h1 align="center">Yii Router FastRoute Adapter</h1>
     <br>
 </p>
 
@@ -33,36 +33,16 @@ composer require yiisoft/router-fastroute
 The package is not meant to be used separately so check [Yii Router](https://github.com/yiisoft/router) readme for
 general usage and [FastRoute](https://github.com/nikic/FastRoute) for pattern syntax.
 
-## Testing
+## Documentation
 
-### Unit testing
+- [Internals](docs/internals.md)
 
-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
-```
+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 Router FastRoute adapter is free software. It is released under the terms of the BSD License.
+The Yii Router FastRoute Adapter 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
new file mode 100644
index 0000000..087a514
--- /dev/null
+++ b/docs/internals.md
@@ -0,0 +1,44 @@
+# 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
+```
+
+## 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:
+
+```shell
+./vendor/bin/rector
+```
+
+## 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:
+
+```shell
+./vendor/bin/composer-require-checker
+```