From 4167138f595ce179cb22a6e86bbbff615449bdfa Mon Sep 17 00:00:00 2001 From: Albert Borsos Date: Mon, 5 Sep 2022 17:57:51 +0200 Subject: [PATCH] update package name and urls in readme.md because it is not restricted to Yii 2.0 anymore --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d857803..87f9b36 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -Mito Yii 2 Coding Standards +Mito PHP Coding Standards =========================== This repository contains [Mito](https://mito.hu/)'s coding standards -for Yii 2 based applications. +for PHP based applications. ![Code coverage](docs/clover.svg) @@ -11,16 +11,16 @@ Getting the code You can get code style definition using one of the following methods. -* Clone `hellowearemito/yii2-coding-standards` repository: +* Clone `hellowearemito/php-coding-standards` repository: ``` -$ git clone git://github.com/hellowearemito/yii2-coding-standards.git +$ git clone git://github.com/hellowearemito/php-coding-standards.git ``` * Install using [composer](https://getcomposer.org/download/): ``` -$ composer require mito/yii2-coding-standards:"~2.0.0@beta" +$ composer require mito/coding-standards:"^3.0" ``` PHP_Codesniffer @@ -47,13 +47,13 @@ For a full description of the rules, see [docs/rules.md](docs/rules.md). After CodeSniffer is installed, you can launch it with a custom standard using the following syntax: ``` -$ ./vendor/bin/phpcs --extensions=php --standard=vendor/mito/yii2-coding-standards/Application . +$ ./vendor/bin/phpcs --extensions=php --standard=vendor/mito/coding-standards/Application . ``` To automatically fix most issues, use phpcbf: ``` -$ ./vendor/bin/phpcbf --extensions=php --standard=vendor/mito/yii2-coding-standards/Application . +$ ./vendor/bin/phpcbf --extensions=php --standard=vendor/mito/coding-standards/Application . ``` **Warning**: always check phpcbf's output and keep backups. If it breaks your code, you get to keep both pieces.