From c2e5a76d4fa6379f2bddcae88c855b7a293e6fc2 Mon Sep 17 00:00:00 2001 From: Ruchit Patel Date: Fri, 29 Sep 2023 13:19:13 +0530 Subject: [PATCH 1/2] Add screenshot of php db auditor command and output. --- README.md | 86 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 62 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index c9d561b..520405b 100644 --- a/README.md +++ b/README.md @@ -10,36 +10,74 @@ ## Installation & Usage -> **Requires [PHP 8.1+](https://php.net/releases/) +**Requires [PHP 8.1+](https://php.net/releases/) Need to install dependency using [Composer](https://getcomposer.org): -> #### **composer install** +#### **composer install** ## Usage: You can see DB Auditor commands using below command. -> #### **php app** -> -> This command provides a list of available commands for database selection, such as checking database standards or verifying constraints. -> +#### **php dbauditor** + + This command provides a list of available commands for database selection, such as checking database standards or verifying constraints. + **Note:** If you want to check standalone feature then you can execute below php command one by one. -> #### **php app db:standard** -> -> This command give you result with list of table with standard follow indication. -> -> - -> #### **php app db:constraint** -> -> This command gives you result with list of tables with primary,foreign,unique,index constraint. -> -> -> You can add more constraint to the table by seeing existing constraint with table. - -> #### **php app db:summary** -> -> This command provides you with information about the database, including its name, size, table count, and character set. -> -> \ No newline at end of file +#### **php dbauditor db:standard** + + This command give you result with list of table with standard follow indication. + +

PHP DB Auditor Standard UI

+ +

PHP DB Auditor Standard UI

+ +

PHP DB Auditor Standard UI

+ + +#### **php dbauditor db:constraint** + + This command gives you result with list of tables with primary,foreign,unique,index constraint. + +

PHP DB Auditor Constraint UI

+ +

PHP DB Auditor Constraint UI

+ +

PHP DB Auditor Constraint UI

+ +

PHP DB Auditor Constraint UI

+ + +You can add more constraint to the table by seeing existing constraint with table. +#### **php dbauditor db:summary** + + This command provides you with information about the database, including its name, size, table count, and character set. + +

PHP DB Auditor Standard UI

+ +## Changelog + +Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details. + + We believe in + 👇 + ACT NOW + PERFECT IT LATER + CORRECT IT ON THE WAY. + +## Security + +If you discover any security-related issues, please email ruchit.patel@viitor.cloud instead of using the issue tracker. + +## Credits + +- [All Contributors](../../contributors) + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. \ No newline at end of file From d84468aa266c239239b18abf2f0dbe7f47c95b74 Mon Sep 17 00:00:00 2001 From: Ruchit Patel Date: Fri, 29 Sep 2023 13:25:54 +0530 Subject: [PATCH 2/2] Update readme file. --- CHANGELOG.md | 4 +++- README.md | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9626128..1702fff 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,5 @@ +All notable changes to `php-db-auditor` will be documented in this file. +## v1.0.0 [29th September 2023] -All notable changes to `php-db-auditor` will be documented in this file. +- Initial release. diff --git a/README.md b/README.md index 520405b..e324744 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +

Logo PHP DB Auditor

+ ![Packagist License](https://img.shields.io/packagist/l/vcian/php-db-auditor?style=for-the-badge) [![Total Downloads](https://img.shields.io/packagist/dt/vcian/php-db-auditor?style=for-the-badge)](https://packagist.org/packages/vcian/php-db-auditor)