Skip to content

Commit ceb70b9

Browse files
committed
Docs folder standardization and other fixes
1 parent 5ff32fe commit ceb70b9

File tree

3 files changed

+19
-36
lines changed

3 files changed

+19
-36
lines changed

LICENSE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
Copyright © 2008 by Yii Software (https://www.yiiframework.com/)
1+
Copyright © 2008 by Yii Software (<https://www.yiiframework.com/>)
22
All rights reserved.
33

44
Redistribution and use in source and binary forms, with or without
55
modification, are permitted provided that the following conditions
66
are met:
77

8-
* Redistributions of source code must retain the above copyright
8+
* Redistributions of source code must retain the above copyright
99
notice, this list of conditions and the following disclaimer.
10-
* Redistributions in binary form must reproduce the above copyright
10+
* Redistributions in binary form must reproduce the above copyright
1111
notice, this list of conditions and the following disclaimer in
1212
the documentation and/or other materials provided with the
1313
distribution.
14-
* Neither the name of Yii Software nor the names of its
14+
* Neither the name of Yii Software nor the names of its
1515
contributors may be used to endorse or promote products derived
1616
from this software without specific prior written permission.
1717

README.md

+13-29
Original file line numberDiff line numberDiff line change
@@ -137,31 +137,6 @@ $client = new \Predis\Client([
137137

138138
> The tests use a connection to a running Redis cluster. If you are not using Docker, you must start the cluster yourself before running the tests.
139139
140-
### Unit testing
141-
142-
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
143-
144-
```shell
145-
./vendor/bin/phpunit
146-
```
147-
148-
### Mutation testing
149-
150-
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
151-
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
152-
153-
```shell
154-
./vendor/bin/roave-infection-static-analysis-plugin
155-
```
156-
157-
### Static analysis
158-
159-
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
160-
161-
```shell
162-
./vendor/bin/psalm
163-
```
164-
165140
## Testing in Docker
166141

167142
### Prepare
@@ -185,12 +160,14 @@ make test v=8.1
185160
make mutation-test v=8.0
186161
```
187162

188-
## License
163+
## Documentation
189164

190-
The Yii Caching Library - Redis Handler is free software. It is released under the terms of the BSD License.
191-
Please see [`LICENSE`](./LICENSE.md) for more information.
165+
- More information can be found in the [Internals.](docs/internals.md)
192166

193-
Maintained by [Yii Software](https://www.yiiframework.com/).
167+
## Support
168+
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).
194171

195172
## Support the project
196173

@@ -203,3 +180,10 @@ Maintained by [Yii Software](https://www.yiiframework.com/).
203180
[![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en)
204181
[![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk)
205182
[![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack)
183+
184+
## License
185+
186+
The Yii Access is free software. It is released under the terms of the BSD License.
187+
Please see [`LICENSE`](./LICENSE.md) for more information.
188+
189+
Maintained by [Yii Software](https://www.yiiframework.com/).

docs/internals.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,9 @@ use either newest or any specific version of PHP:
3434
./vendor/bin/rector
3535
```
3636

37-
## Dependencies
37+
## Composer require checker
3838

39-
Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive
40-
[Composer](https://getcomposer.org/) dependencies.
39+
This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.
4140

4241
To run the checker, execute the following command:
4342

0 commit comments

Comments
 (0)