readme.md

chinese.md

@@ -0,0 +1,58 @@
+## Laravel-Cadillac
+
+该扩展包基于 Laravel 开发，请确保您是在 Laravel 下使用。在日常的开发当中，数据表的某些结构可能会产生一定的变动，例如：增加一个字段或减少一个字段等。如果项目的开发周期较长，我们可能会忘掉一些数据表的结构以至于我们需要查看 `Migration` 文件或进入 `Mysql` 查看数据表的结构，但是我认为这是一件浪费时间的事情！因此，我开发了这个包，当我们需要查看那些我们记得不是很清楚的数据表的结构的时候，只需要一个命令就可以了！
+
+
+## 安装
+
+```
+composer require qsnh/laravel-cadillac dev-master --dev
+```
+
+> 推荐您在开发环境下使用。
+
+
+## 命令
+
+```
+php artisan cadillac [tableName] --export --html
+```
+
+
+#### 显示当前数据库所有的表
+
+```
+php artisan cadillac
+```
+
+![php artisan cadillac](https://user-images.githubusercontent.com/12671205/37866385-27acd13a-2fc5-11e8-8a54-be6110686999.gif)
+
+#### 查看某个表的结构
+
+```
+php artisan cadillac tableName
+```
+
+![php artisan cadillac tableName](https://user-images.githubusercontent.com/12671205/37866390-338b15a2-2fc5-11e8-833f-5749c693842d.gif)
+
+
+#### 将当前数据库所有的表结构导入到 MARKDOWN 文件中
+
+```
+php artisan cadillac --export
+```
+
+![php artisan cadillac --export](https://user-images.githubusercontent.com/12671205/37866396-40fa712e-2fc5-11e8-8559-e678ac3993ee.gif)
+
+#### 将当前数据库所有的表结构导入到 HTML 文件中
+
+```
+php artisan cadillac --export --html
+```
+
+![php artisan cadillac --export --html](https://user-images.githubusercontent.com/12671205/37866411-7c6fcb8c-2fc5-11e8-92b3-5ccaf8f3b5d2.gif)
+
+
+## 作者
+
+[Qsnh](https://github.com/Qsnh)

composer.json

@@ -13,10 +13,7 @@
     "autoload": {
         "psr-4": {
             "Qsnh\\Cadillac\\": "src"
-        },
-        "files": [
-            "autoload.php"
-        ]
+        }
     },
     "require": {
     },

readme.md

@@ -0,0 +1,59 @@
+## Laravel-Cadillac
+
+This package develop on laravel, please confirm use it on laravel project.In the daily development, some structures of the data table may have certain changes, such as: add one field or remove one field. If the development cycle of the project is long, we may forget about the structure of some data tables so that we need to look at the `Migration` file or enter `Mysql` to see the structure of the data table, but I think this is a waste of time! Therefore, I developed this package. When we need to look at the structure of data tables that we do not remember very clearly, we only need one command!
+
+[中文文档](chinese.md)
+
+## Install
+
+```
+composer require qsnh/laravel-cadillac dev-master --dev
+```
+
+> It's recommended use it in develop environment.
+
+
+## 命令
+
+```
+php artisan cadillac [tableName] --export --html
+```
+
+
+#### Show all tables in current database
+
+```
+php artisan cadillac
+```
+
+![php artisan cadillac](https://user-images.githubusercontent.com/12671205/37866385-27acd13a-2fc5-11e8-8a54-be6110686999.gif)
+
+#### Show a table structure
+
+```
+php artisan cadillac tableName
+```
+
+![php artisan cadillac tableName](https://user-images.githubusercontent.com/12671205/37866390-338b15a2-2fc5-11e8-833f-5749c693842d.gif)
+
+
+#### Import all the table structures of the current database into the MARKDOWN file
+
+```
+php artisan cadillac --export
+```
+
+![php artisan cadillac --export](https://user-images.githubusercontent.com/12671205/37866396-40fa712e-2fc5-11e8-8559-e678ac3993ee.gif)
+
+#### Import all the table structures of the current database into the HTML file
+
+```
+php artisan cadillac --export --html
+```
+
+![php artisan cadillac --export --html](https://user-images.githubusercontent.com/12671205/37866411-7c6fcb8c-2fc5-11e8-92b3-5ccaf8f3b5d2.gif)
+
+
+## Author
+
+[Qsnh](https://github.com/Qsnh)