diff --git a/LICENSE.md b/LICENSE.md index bc5674f..5fbe395 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,17 +1,17 @@ -Copyright © 2008 by Yii Software (https://www.yiiframework.com/) +Copyright © 2008-present by Yii Software () All rights reserved. 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 116af4d..7945b5c 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,23 @@ The package could be installed with composer: composer require yiisoft/cache-memcached ``` +## Development environment + +For greater ease it is recommended to use docker containers. + +Run container with memcached directly via command: + +```dockerfile +docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11211 memcached:1.6.23 +``` + +Memcached must be accessible by address `127.0.0.1`. If you use PHP via docker container, run PHP container in network +of memcached container. Use `docker run` command argument for it: + +```dockerfile +--network container:yiisoft-cache-memcached-cache +``` + ## Configuration Creating an instance: @@ -126,14 +143,12 @@ This package can be used as a cache handler for the [Yii Caching Library](https: ## Documentation -More information can be found in the [Internals](docs/internals.md). - -## License +- More information can be found in the [Internals.](docs/internals.md) -The Yii Cache Library - Memcached Handler is free software. It is released under the terms of the BSD License. -Please see [`LICENSE`](./LICENSE.md) for more information. +## Support -Maintained by [Yii Software](https://www.yiiframework.com/). +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). ## Support the project @@ -146,3 +161,10 @@ Maintained by [Yii Software](https://www.yiiframework.com/). [![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 Access 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 fa49c67..8dc4049 100644 --- a/docs/internals.md +++ b/docs/internals.md @@ -1,22 +1,5 @@ # Internals -## Development environment - -For greater ease it is recommended to use docker containers. - -Run container with memcached directly via command: - -```dockerfile -docker run --rm --name yiisoft-cache-memcached-cache --detach --publish 11211:11211 memcached:1.6.23 -``` - -Memcached must be accessible by address `127.0.0.1`. If you use PHP via docker container, run PHP container in network -of memcached container. Use `docker run` command argument for it: - -```dockerfile ---network container:yiisoft-cache-memcached-cache -``` - ## Unit testing The package is tested with [PHPUnit](https://phpunit.de/). To run tests: @@ -51,10 +34,9 @@ use either newest or any specific version of PHP: ./vendor/bin/rector ``` -## Dependencies +## Composer require checker -Use [ComposerRequireChecker](https://github.com/maglnet/ComposerRequireChecker) to detect transitive -[Composer](https://getcomposer.org/) dependencies. +This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`. To run the checker, execute the following command: