Laravel Readme Update (#154)

Added options column in php-laravel's Readme

Author: Thiyagu55

php/sqlcommenter-php/packages/sqlcommenter-laravel/README.md

@@ -1,31 +1,19 @@
-# sqlcommenter-laravel [In Development]
+# Sqlcommenter-laravel
 
-sqlcommenter is a plugin/middleware/wrapper to augment SQL statements from laravel
+Sqlcommenter is a plugin/middleware/wrapper to augment SQL statements from laravel
 with comments that can be used later to correlate user code with SQL statements.
 
+## Installation
 
-### Installation
-
-Add this to your `composer.json`
-```shell
-"repositories": [
-    {
-        "type": "path",
-        "url": "/full/or/relative/path/to/sqlcommenter-laravel/package"
-    }
-]
-```
-Install the package
 ```shell
 composer require "google/sqlcommenter-laravel"
 ```
-### Usage
+## Usage
 
 Publish the config file from library to into laravel app using below command
 
 ```shell
 php artisan vendor:publish --provider="Google\GoogleSqlCommenterLaravel\GoogleSqlCommenterServiceProvider"
-
 ```
 
 Add the following class above `Illuminate\Database\DatabaseServiceProvider::class`,
@@ -38,9 +26,16 @@ Add the following class above `Illuminate\Database\DatabaseServiceProvider::clas
     ...
 ]
 ```
-### Run unit tests
 
-Run unit tests using below command
-```shell
-./vendor/bin/phpunit tests
-```
+## Options
+
+With Laravel SqlCommenter, we have configuration to choose which tags to be appended to the comment. It is configurable in `config/google_sqlcommenter.php`
+
+| Field         | Included <br /> by default?                    | Description                                                                                                                 |
+| ------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `action`      | <div style="text-align: center">&#10004;</div> | The [application namespace](https://laravel.com/docs/9.x/controllers) of the matching URL pattern in your routes/api.php    |
+| `controller`  | <div style="text-align: center">&#10004;</div> | The [name](https://laravel.com/docs/9.x/controllers) of the matching URL pattern as described in your routes/api.php        |
+| `db_driver`   | <div style="text-align: center">&#10004;</div> | The name of the php [database engine](https://laravel.com/docs/9.x/database)                                                |
+| `framework`   | <div style="text-align: center">&#10004;</div> | The word "laravel" and the version of laravel being used                                                                    |
+| `route`       | <div style="text-align: center">&#10004;</div> | The [route](https://laravel.com/docs/9.x/routing) of the matching URL pattern as described in your routes/api.php           |
+| `traceparent` | <div style="text-align: center">&#10004;</div> | The [W3C TraceContext.Traceparent field](https://www.w3.org/TR/trace-context/#traceparent-field) of the OpenTelemetry trace |