Improve README

Author: erickhun

README.md

@@ -2,15 +2,55 @@
 
 PHP logger for all Buffer services
 
-## Requirements:
 
-- 1 - Install composer by following [those steps](https://getcomposer.org/download/)
-- 2 (optional) - `mv composer.phar /usr/local/bin/composer`
+## Requirements
 
+PHP 7.1 and later.
+
+## Setup BuffLog in your PHP project via Composer
+
+You can install the bindings via [Composer](http://getcomposer.org/). Run the following command:
+
+```bash
+composer require bufferapp/php-bufflog
+```
+
+
+## Usage
+As simple as...
+
+```php
+use Buffer\Bufflog;
+
+Bufflog::debug("I am a debug");
+Bufflog::info("I am an info");
+Bufflog::warn("I am a warning");
+Bufflog::error("I am an error");
+Bufflog::critical("I am a warning");
+```
+
+If you wish add more context in your logs, 
+```php
+Bufflog::debug("some context", ["my key" => " my value"]);
+Bufflog::info("I am a info with context", ["my key" => " my value"]);
+Bufflog::warn("I am a warning", ["duration" => "40ms"]);
+
+Bufflog::critical("I'm critical log, here some extra fancy informations",
+                    [
+                        "duration" => "40ms",
+                        "services_related" => [
+                            "Twitter",
+                            "Facebook",
+                            "Instagram"
+                        ]
+                    ]
+                );
+
+```
 
 ## Install the project
 
 ```
-# This will install all the dependencies
+# This will install all the dependencies this project needs
 composer install
 ```

example.php

@@ -7,7 +7,7 @@
 Bufflog::debug("I am a debug with context", ["my key" => " my value"]);
 
 Bufflog::info("I am an info");
-Bufflog::debug("I am a info with context", ["my key" => " my value"]);
+Bufflog::info("I am a info with context", ["my key" => " my value"]);
 
 Bufflog::warn("I am a warning");
 Bufflog::warn("I am a warning", ["duration" => "40ms"]);
@@ -17,3 +17,14 @@
 
 Bufflog::critical("I am critical information!");
 Bufflog::critical("I am critical information!", ["user" => "betrand"]);
+
+Bufflog::critical("I'm critical log, here some extra fancy informations", 
+                    [
+                        "duration" => "40ms",
+                        "services_related" => [
+                            "Twitter",
+                            "Facebook",
+                            "Instagram"
+                        ]
+                    ]
+                );

src/php-bufflog/BuffLog.php

@@ -22,34 +22,34 @@ class BuffLog {
 
     private static $logger = null;
 
-    public static function debug($message)
+    public static function debug($message, $context = [], $extra = [])
     {
-        $logOutput = self::formatLog($message, Logger::DEBUG, $context = [], $extra = []);
+        $logOutput = self::formatLog($message, Logger::DEBUG, $context, $extra);
         self::getLogger()->debug($logOutput);
     }
 
-    public static function info($message)
+    public static function info($message, $context = [], $extra = [])
     {
-        $logOutput = self::formatLog($message, Logger::INFO, $context = [], $extra = []);
+        $logOutput = self::formatLog($message, Logger::INFO, $context, $extra);
         self::getLogger()->info($logOutput);
     }
 
-    public static function warn($message)
+    public static function warn($message, $context = [], $extra = [])
     {
-        $logOutput = self::formatLog($message, Logger::WARNING, $context = [], $extra = []);
+        $logOutput = self::formatLog($message, Logger::WARNING, $context, $extra);
         self::getLogger()->warn($logOutput);
     }
 
-    public static function error($message)
+    public static function error($message, $context = [], $extra = [])
     {
-        $logOutput = self::formatLog($message, Logger::ERROR, $context = [], $extra = []);
+        $logOutput = self::formatLog($message, Logger::ERROR, $context, $extra);
         self::getLogger()->error($logOutput);
     }
 
     // @TODO: That one might could also create an alert in Datadog?
-    public static function critical($message)
+    public static function critical($message, $context = [], $extra = [])
     {
-        $logOutput = self::formatLog($message, Logger::CRITICAL, $context = [], $extra = []);
+        $logOutput = self::formatLog($message, Logger::CRITICAL, $context, $extra);
         self::getLogger()->critical($logOutput);
     }