diff --git a/CHANGELOG.md b/CHANGELOG.md index 8061748..6d567fc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,5 @@ # Yii Postgres Mutex Change Log - ## 1.1.1 under development - no changes in this release. diff --git a/README.md b/README.md index b684bc6..a38a1d0 100644 --- a/README.md +++ b/README.md @@ -24,10 +24,10 @@ This library provides a PostgreSQL mutex implementation for [yiisoft/mutex](http ## Installation -The package could be installed with composer: +The package could be installed with [Composer](https://getcomposer.org): ```shell -composer require yiisoft/mutex-pdo-pgsql --prefer-dist +composer require yiisoft/mutex-pdo-pgsql ``` ## General usage @@ -99,36 +99,16 @@ $mutex = $mutex->withRetryDelay(100); By default, it is 50 milliseconds - it means that we may try to acquire lock up to 20 times per second. -## 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 PostgreSQL mutex is free software. It is released under the terms of the BSD License. +The Yii Mutex Library - PostgreSQL PDO Driver 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/composer.json b/composer.json index fd52803..f6a3542 100644 --- a/composer.json +++ b/composer.json @@ -12,7 +12,7 @@ "issues": "https://github.com/yiisoft/mutex-pdo-pgsql/issues?state=open", "forum": "https://www.yiiframework.com/forum/", "wiki": "https://www.yiiframework.com/wiki/", - "irc": "irc://irc.freenode.net/yii", + "irc": "ircs://irc.libera.chat:6697/yii", "chat": "https://t.me/yii3en", "source": "https://github.com/yiisoft/mutex-pdo-pgsql" }, diff --git a/docs/internals.md b/docs/internals.md new file mode 100644 index 0000000..b37b5b8 --- /dev/null +++ b/docs/internals.md @@ -0,0 +1,26 @@ +# 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 +```