diff --git a/README.md b/README.md
index b803264..ee61a2f 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,13 @@
Wrapper with pre-defined rules around the [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) package โ A tool to automatically fix PHP Coding Standards issues.
-If you **like/use** this package, please consider **starring** it. Thanks!
+This repository aims to provide a standardized way to apply coding standards across multiple projects, ensuring consistency and adherence to best practices.
+
+By using predefined rulesets, it simplifies the setup process and allows teams to quickly integrate PHP-CS-Fixer into their development workflow.
+
+
+
+If you **like/use** this package, please consider โญ๏ธ **starring** it. Thanks!
@@ -38,100 +44,111 @@ If you **like/use** this package, please consider **starring** it. Thanks!
Require as dependency:
```bash
-composer req wayofdev/cs-fixer-config
+composer req --dev wayofdev/cs-fixer-config
```
## ๐ Configuration
-1. Create PHP file and name it `.php-cs-fixer.dist.php` and place it inside root directory of project. It will be recognized by PHP CS Fixer automatically.
+### โ Setup
-2. Example contents of `.php-cs-fixer.dist.php` file:
+- Create PHP file and name it `.php-cs-fixer.dist.php` and place it inside root directory of project. It will be recognized by PHP CS Fixer automatically.
+
+- Example contents of `.php-cs-fixer.dist.php` file:
```php
- inDir(__DIR__ . '/src')
+ ->inDir(__DIR__ . '/tests')
+ ->addFiles([__FILE__])
+ ->getConfig()
+ ;
+
+ $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/php-cs-fixer.cache');
+
+ return $config;
+ ```
- declare(strict_types=1);
+### โ Composer Script
- use WayOfDev\PhpCsFixer\Config\ConfigBuilder;
- use WayOfDev\PhpCsFixer\Config\RuleSets\DefaultSet;
+- Add `scripts` section to `composer.json`:
+
+ ```diff
+ {
+ "scripts": {
+ + "cs:diff": "php vendor/bin/php-cs-fixer fix --dry-run -v --diff",
+ + "cs:fix": "php vendor/bin/php-cs-fixer fix -v"
+ }
+ }
+ ```
- require_once 'vendor/autoload.php';
+### โ Git
- return ConfigBuilder::createFromRuleSet(new DefaultSet())
- ->inDir(__DIR__ . '/src')
- ->inDir(__DIR__ . '/tests')
- ->addFiles([__FILE__])
- ->getConfig();
- ```
+- Place `.build` folder file into `.gitignore`
+
+ ```diff
+ +/.build/
+ /vendor/
+ ```
-3. Place `.php-cs-fixer.cache` file into `.gitignore`
+### โ GitHub Actions
+
+To use in GitHub Actions, do...
## ๐ป Usage
-### โ Running
-
Fix coding standards by simply running console command:
+### โ Directly
+
```bash
-php vendor/bin/php-cs-fixer fix -v
+vendor/bin/php-cs-fixer fix -v
```
-### โ Using Makefile
+### โ Via Composer Script
-To use with our `Makefile`:
+To use via composer script commands:
-1. Add `scripts` section to `composer.json`:
+* Fixes code to follow coding standards using php-cs-fixer:
- ```json
- {
- "scripts": {
- "cs-fix": "php vendor/bin/php-cs-fixer fix -v",
- "cs-diff": "php vendor/bin/php-cs-fixer fix --dry-run -v --diff"
- }
- }
- ```
+ ```bash
+ composer cs:diff
+ ```
-2. Use `Makefile` code to run PHP-CS-Fixer tests:
+* Runs php-cs-fixer in dry-run mode and shows diff which will by applied:
- ```bash
- # Run inspections and fix code
- $ make cs-fix
-
- # Check coding standards without applying the fix
- $ make cs-diff
- ```
+ ```bash
+ composer cs:fix
+ ```
-
-
-## ๐งช Running Tests
-
-### โ PHPUnit tests
-
-To run tests, run the following command:
-
-```bash
-make test
-```
+### โ Using Makefile
-### โ Static Analysis
+**To use with `Makefile`**
-Code quality using PHPStan:
+- Fixes code to follow coding standards using php-cs-fixer:
-```bash
-make stan
-```
+ ```bash
+ make lint-php
+ ```
-### โ Coding Standards Fixing
+- Runs php-cs-fixer in dry-run mode and shows diff which will by applied:
-Fix code using The PHP Coding Standards Fixer (PHP CS Fixer) to follow our standards:
+ ```bash
+ make lint-diff
+ ```
-```bash
-make cs-fix
-```
@@ -158,9 +175,11 @@ You are more than welcome. Before contributing, kindly check our [contribution g
## ๐ซก Contributors
-
-
-
+
+ + + +