Skip to content

Commit 77372d7

Browse files
luizcmarinvjik
andauthored
Fix docs (#31)
Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>
1 parent 90b3047 commit 77372d7

File tree

4 files changed

+34
-29
lines changed

4 files changed

+34
-29
lines changed

CHANGELOG.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Yii Postgres Mutex Change Log
22

3-
43
## 1.1.1 under development
54

65
- no changes in this release.

README.md

Lines changed: 7 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ This library provides a PostgreSQL mutex implementation for [yiisoft/mutex](http
2424

2525
## Installation
2626

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

2929
```shell
30-
composer require yiisoft/mutex-pdo-pgsql --prefer-dist
30+
composer require yiisoft/mutex-pdo-pgsql
3131
```
3232

3333
## General usage
@@ -99,36 +99,16 @@ $mutex = $mutex->withRetryDelay(100);
9999

100100
By default, it is 50 milliseconds - it means that we may try to acquire lock up to 20 times per second.
101101

102-
## Testing
102+
## Documentation
103103

104-
### Unit testing
104+
- [Internals](docs/internals.md)
105105

106-
The package is tested with [PHPUnit](https://phpunit.de/). To run tests:
107-
108-
```shell
109-
./vendor/bin/phpunit
110-
```
111-
112-
### Mutation testing
113-
114-
The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
115-
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:
116-
117-
```shell
118-
./vendor/bin/roave-infection-static-analysis-plugin
119-
```
120-
121-
### Static analysis
122-
123-
The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:
124-
125-
```shell
126-
./vendor/bin/psalm
127-
```
106+
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.
107+
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
128108

129109
## License
130110

131-
The Yii PostgreSQL mutex is free software. It is released under the terms of the BSD License.
111+
The Yii Mutex Library - PostgreSQL PDO Driver is free software. It is released under the terms of the BSD License.
132112
Please see [`LICENSE`](./LICENSE.md) for more information.
133113

134114
Maintained by [Yii Software](https://www.yiiframework.com/).

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
"issues": "https://github.com/yiisoft/mutex-pdo-pgsql/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/mutex-pdo-pgsql"
1818
},

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)