Skip to content

Commit 28d9972

Browse files
luizcmarinvjik
andauthored
Update file (#99)
Co-authored-by: Sergei Predvoditelev <[email protected]>
1 parent 55ae8b5 commit 28d9972

File tree

4 files changed

+8
-28
lines changed

4 files changed

+8
-28
lines changed

README.md

+5-25
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ request instance, dispatcher executes it and produces a response instance.
2525

2626
## Installation
2727

28-
The package could be installed with composer:
28+
The package could be installed with [Composer](https://getcomposer.org):
2929

3030
```shell
3131
composer require yiisoft/middleware-dispatcher
@@ -162,32 +162,12 @@ $dispatcher = new MiddlewareDispatcher(
162162
);
163163
```
164164

165-
## Testing
165+
## Documentation
166166

167-
### Unit testing
167+
- [Internals](docs/internals.md)
168168

169-
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
170-
171-
```shell
172-
./vendor/bin/phpunit
173-
```
174-
175-
### Mutation testing
176-
177-
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
178-
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
179-
180-
```shell
181-
./vendor/bin/roave-infection-static-analysis-plugin
182-
```
183-
184-
### Static analysis
185-
186-
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
187-
188-
```shell
189-
./vendor/bin/psalm
190-
```
169+
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.
170+
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
191171

192172
## License
193173

composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"issues": "https://github.com/yiisoft/middleware-dispatcher/issues?state=open",
1313
"forum": "https://www.yiiframework.com/forum/",
1414
"wiki": "https://www.yiiframework.com/wiki/",
15-
"irc": "irc://irc.freenode.net/yii",
15+
"irc": "ircs://irc.libera.chat:6697/yii",
1616
"chat": "https://t.me/yii3en",
1717
"source": "https://github.com/yiisoft/middleware-dispatcher"
1818
},

docs/internals.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static
2525
./vendor/bin/psalm
2626
```
2727

28-
## Rector
28+
## Code style
2929

3030
Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
3131
use either newest or any specific version of PHP:

psalm.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
errorLevel="1"
44
findUnusedBaselineEntry="true"
55
findUnusedCode="false"
6-
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
6+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
77
xmlns="https://getpsalm.org/schema/config"
88
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
99
>

0 commit comments

Comments
 (0)