Skip to content

Commit 54e6f0b

Browse files
luizcmarinvjik
andauthored
Fix docs (#54)
Co-authored-by: Sergei Predvoditelev <[email protected]>
1 parent 54e912d commit 54e6f0b

File tree

2 files changed

+32
-26
lines changed

2 files changed

+32
-26
lines changed

README.md

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ The package contains various network utilities useful for:
2929

3030
## Installation
3131

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

3434
```shell
35-
composer require yiisoft/network-utilities --prefer-dist
35+
composer require yiisoft/network-utilities
3636
```
3737

3838
## General usage
@@ -74,32 +74,12 @@ if (!DnsHelper::existsA('yiiframework.com')) {
7474
}
7575
```
7676

77-
## Testing
77+
## Documentation
7878

79-
### Unit testing
79+
- [Internals](docs/internals.md)
8080

81-
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
82-
83-
```shell
84-
./vendor/bin/phpunit
85-
```
86-
87-
### Mutation testing
88-
89-
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
90-
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
91-
92-
```shell
93-
./vendor/bin/roave-infection-static-analysis-plugin
94-
```
95-
96-
### Static analysis
97-
98-
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
99-
100-
```shell
101-
./vendor/bin/psalm
102-
```
81+
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.
82+
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
10383

10484
## License
10585

docs/internals.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Internals
2+
3+
## Unit testing
4+
5+
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
6+
7+
```shell
8+
./vendor/bin/phpunit
9+
```
10+
11+
## Mutation testing
12+
13+
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
14+
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
15+
16+
```shell
17+
./vendor/bin/roave-infection-static-analysis-plugin
18+
```
19+
20+
## Static analysis
21+
22+
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
23+
24+
```shell
25+
./vendor/bin/psalm
26+
```

0 commit comments

Comments
 (0)