Merge pull request #5 from karam-mustafa/main

Fix README file

Author: karam-mustafa

README.md

@@ -23,8 +23,8 @@ Usage
 The Basic Usage of this package is the same of getting count of some model instances, but with a styled response 
 
 ```php
-        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics(ModelName)); 
-        // EX: new RelationalMetrics(Store);
+        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
+        // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
         $metrics = $instance->getBasicMetrics();
         /*
 	  *     Response will be like:
@@ -40,10 +40,10 @@ What you can do next, you could get the metrics of a model depending on one of i
 Let's assume we want to get the number of stores that has products with price more than 500
 
 ```php
-        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics(ModelName)); 
-        // EX: new RelationalMetrics(Store);
+        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
+        // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
         $metrics = $instance->getRelationalMetrics($relationName, $relationColumn, $value);
-        // EX: $instance->getRelationalMetrics('products, 'price', 500);
+        // example: $instance->getRelationalMetrics('products, 'price', 500);
         /*
 	  *     Response will be like:
 	  *	[
@@ -60,15 +60,16 @@ And last but not least, You could get the metrics about a model depending on any
 
 
 ```php
-        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics(ModelName)); 
-        // EX: new RelationalMetrics(Store);
+        $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
+        // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
+        
+        // example for the conditions
+        $conditions = [
+                  ['method' => 'where', 'column' => 'address', 'operator' => 'like', 'value' => '%UAE%'],
+                  ['method' => 'where', 'column' => 'rate', 'operator' => '>', 'value' => 3],
+        ];
         $metrics = $instance->getRelationalMetrics($conditions);
-        // EX: $instance->getRelationalMetrics(
-        	[
-        		['method' => 'where', 'column' => 'address', 'operator' => 'like', 'value' => '%UAE%'],
-        		['method' => 'where', 'column' => 'rate', 'operator' => '>', 'value' => 3],
-        	]
-        );
+        	
         /*
 	  *     Response will be like:
 	  *	[
@@ -88,11 +89,11 @@ Please see the [CHANGELOG](https://github.com/syrian-open-source/laravel-relatio
 
 Security
 --------
-If you discover any security related issues, please email them first to "zainaldeenfayod@gmail.com", 
+If you discover any security related issues, please email them first to zainaldeenfayod@gmail.com, 
 if we do not fix it within a short period of time please open a new issue describing your problem. 
 
 Credits
 -------
-* [zainaldeenfayod@gmail.com](https://github.com/zainaldeen/laravel-relational-metrics-1)
+* [Zain Aldeen Fayod](https://www.linkedin.com/in/zainaldeenfayod/)
 * [All contributors](https://github.com/syrian-open-source/laravel-relational-metrics/graphs/contributors)