wip

readme.md

@@ -34,9 +34,11 @@ You can configure the several options with the server, such as the host, the por
 
 ### Passing configuration via the constructor or Server::new()
 
-You may pass most configuration options via the constructor as shown below where we set the `host`, `port` and `root` options. 
+You may pass most configuration options via the constructor. For example we are setting the `host`, `port` and `root` options in the code below. 
 
 ```PHP
+use Statix\Server\Server;
+
 Server::new([
     'host' => 'localhost',
     'port' => 8000,
@@ -50,7 +52,11 @@ new Server([
     'port' => 8000,
     'root' => __DIR__ . '/content'
 ]);
+```
+
+The complete list of configuration items that can be passed via the constructor can be found below. 
 
+```PHP
 $optionsSettableViaContructor = [
     'host' => 'string', // default: localhost
     'port' => 'string|int', // default: 8000
@@ -65,8 +71,10 @@ $optionsSettableViaContructor = [
 
 ### Setting configuration via the named methods
 
+You also have the option of calling named methods to set the configuration options as shown below. 
+
 ```PHP
-use Statix\Server;
+use Statix\Server\Server;
 
 Server::new()
     ->usePHP('path') 
@@ -75,10 +83,8 @@ Server::new()
     ->root('./content')
     ->useRouter('./router.php')
     ->withoutEnvVars([
-        //
-    ])->filterEnvVars(function($value, $key) { 
-        //
-    })
+        'APP_KEY',
+    ]);
 ```
 
 ### Capturing the output from the server process

src/Server.php

@@ -10,29 +10,29 @@ class Server
 {
     /**
      * The user passed configuration array
-     * 
-     * @param array $baseConfiguration
+     *
+     * @param  array  $baseConfiguration
      */
     protected $baseConfiguration;
 
     /**
      * The default and user merged configuration array
-     * 
-     * @param array $configuration
+     *
+     * @param  array  $configuration
      */
     protected $configuration;
 
     /**
      * The output handler to pass process output to
-     * 
-     * @param callable $outputHandler
+     *
+     * @param  callable  $outputHandler
      */
     protected $outputHandler;
 
     /**
      * The env vars which will be passed to the server process
-     * 
-     * @param array $envVarsToPass
+     *
+     * @param  array  $envVarsToPass
      */
     protected $envVarsToPass;
 
@@ -46,11 +46,11 @@ public function __construct(array $configuration = [])
         $this->baseConfiguration = $configuration;
 
         $this->configuration = array_merge($defaults = [
-            'host' => 'localhost', 
-            'port' => 8000, 
-            'root' => getcwd(), 
+            'host' => 'localhost',
+            'port' => 8000,
+            'root' => getcwd(),
             'executable' => null,
-            'router' => null, 
+            'router' => null,
             'withoutEnvVars' => [],
         ], $configuration);
 
@@ -116,11 +116,11 @@ public function useRouter(string $path): self
     public function filterEnvVars(callable $callback): self
     {
         $this->envVarsToPass = array_filter(
-            $this->envVarsToPass, 
-            $callback, 
+            $this->envVarsToPass,
+            $callback,
             ARRAY_FILTER_USE_BOTH
         );
-        
+
         return $this;
     }
 
@@ -129,7 +129,7 @@ private function findExecutable(): string
         if ($this->configuration['executable'] != null) {
             return $this->configuration['executable'];
         }
-        
+
         return (new PhpExecutableFinder)->find(false);
     }
 
@@ -147,7 +147,7 @@ private function buildServeCommand(): array
 
     private function buildPassingEnvVarArray(): array
     {
-        return array_filter($this->envVarsToPass, function($key) {
+        return array_filter($this->envVarsToPass, function ($key) {
             return in_array($key, $this->configuration['withoutEnvVars']);
         }, ARRAY_FILTER_USE_KEY);
     }
@@ -163,7 +163,7 @@ private function initProcess(): Process
         );
 
         $process->start(function ($type, $buffer) {
-            if($this->outputHandler != null) {
+            if ($this->outputHandler != null) {
                 ($this->outputHandler)($buffer);
             }
         });
@@ -188,4 +188,4 @@ public function runInBackground(): int|null
 
         return $process->getExitCode();
     }
-}
+}