From 19b112d47f54af4612222fb65cfe50c52c4f6f93 Mon Sep 17 00:00:00 2001 From: Luiz Marin <67489841+luizcmarin@users.noreply.github.com> Date: Tue, 7 May 2024 13:29:15 -0300 Subject: [PATCH] Fix docs (#66) Co-authored-by: Sergei Predvoditelev --- LICENSE.md | 6 +++--- README.md | 24 +++++++++++------------- docs/internals.md | 6 ++---- 3 files changed, 16 insertions(+), 20 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index 6a920d60..c48bcea7 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -5,13 +5,13 @@ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -* Redistributions of source code must retain the above copyright + * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -* Redistributions in binary form must reproduce the above copyright + * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -* Neither the name of Yii Software nor the names of its + * Neither the name of Yii Software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/README.md b/README.md index 443f0137..fd758f5f 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,13 @@ a lock before accessing the corresponding data. ## Installation -The package could be installed with composer: +The package could be installed with [Composer](https://getcomposer.org): ```shell -composer require yiisoft/mutex --prefer-dist +composer require yiisoft/mutex ``` -## Usage +## General usage There are multiple ways you can use the package. You can execute a callback in a synchronized mode i.e. only a single instance of the callback is executed at the same time: @@ -118,10 +118,15 @@ these functions in the destructor and shutdown function will prevent all subsequ - [Internals](docs/internals.md) -## Support +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). -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 Mutex 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/). ## Support the project @@ -134,10 +139,3 @@ You may also check out other [Yii Community Resources](https://www.yiiframework. [![Telegram](https://img.shields.io/badge/telegram-join-1DA1F2?style=flat&logo=telegram)](https://t.me/yii3en) [![Facebook](https://img.shields.io/badge/facebook-join-1DA1F2?style=flat&logo=facebook&logoColor=ffffff)](https://www.facebook.com/groups/yiitalk) [![Slack](https://img.shields.io/badge/slack-join-1DA1F2?style=flat&logo=slack)](https://yiiframework.com/go/slack) - -## License - -The Yii Mutex 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/docs/internals.md b/docs/internals.md index b715d9fb..58cc6435 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -25,7 +25,7 @@ The code is statically analyzed with [Psalm](https://psalm.dev/). To run static ./vendor/bin/psalm ``` -## Rector +## Code style Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or use either newest or any specific version of PHP: @@ -37,9 +37,7 @@ use either newest or any specific version of PHP: ## Dependencies Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive -[Composer](https://getcomposer.org/) dependencies. - -To run the checker, execute the following command: +[Composer](https://getcomposer.org/) dependencies. To run the checker, execute the following command: ```shell ./vendor/bin/composer-require-checker