Update readme and changelog

Author: mikehaertl

CHANGELOG.md

@@ -1,5 +1,58 @@
 # CHANGELOG
 
+## 1.6.4
+
+ * Let getExecCommand() not cache the created command string
+
+## 1.6.3
+
+ * Include PHP 5.3 in version requirements
+
+## 1.6.2
+
+ * Add .gitattributes to reduce package size
+
+## 1.6.1
+
+ * Issue #44 Fix potential security issue with escaping shell args (@Kirill89 / https://snyk.io/)
+
+## 1.6.0
+
+ * Issue #24 Implement timeout feature
+
+## 1.5.0
+
+ * Issue #20 Refactor handling of stdin/stdou/sterr streams with proc_open().
+   By default these streams now operate in non-blocking mode which should fix
+   many hanging issues that were caused when the command received/sent a lot of
+   input/output. This is the new default on Non-Windows systems (it's not
+   supported on Windows, though). To get the old behavior the nonBlockingMode
+   option can be set to false.
+
+## 1.4.1
+
+ * Allow command names with spaces on Windows (@Robindfuller )
+
+## 1.4.0
+
+ * Allow stdin to be a stream or a file handle (@Arzaroth)
+
+## 1.3.0
+
+ * Add setStdIn() which allows to pipe an input string to the command (@martinqvistgard)
+
+## 1.2.5
+
+ * Issue #22 Fix execution of relative file paths on windows
+
+## 1.2.4
+
+ * Reverted changes for Issue #20 as this introduced BC breaking problems
+
+## 1.2.3
+
+ * Issue #20: Read stderr before stdout to avoid hanging processes
+
 ## 1.2.2
 
  * Issue #16: Command on different drive didn't work on windows

README.md

@@ -28,6 +28,8 @@ composer require mikehaertl/php-shellcommand
  * Catches `stdOut`, `stdErr` and `exitCode`
  * Handle argument escaping
  * Pass environment vars and other options to `proc_open()`
+ * Pipe resources like files or streams into the command
+ * Timeout for execution
 
 ## Examples
 
@@ -49,7 +51,69 @@ if ($command->execute()) {
 
 ### Advanced Features
 
+#### Add Arguments
 ```php
+<?php
+$command = new Command('/bin/somecommand');
+// Add arguments with correct escaping:
+// results in --name='d'\''Artagnan'
+$command->addArg('--name=', "d'Artagnan");
+
+// Add argument with several values
+// results in --keys key1 key2
+$command->addArg('--keys', array('key1','key2'));
+```
+
+### Pipe Input Into Command
+
+From string:
+```php
+<?php
+$command = new ('jq') // jq is a pretty printer
+$command->setStdIn('{"foo": 0}');
+if (!$command->execute()) {
+    echo $command->getError();
+} else {
+    echo $command->getOutput();
+}
+// Output:
+// {
+//   "foo": 0
+// }
+```
+
+From file:
+```php
+<?php
+$fh = fopen('test.json', 'r');
+// error checks left out...
+$command = new Command('jq');
+$command->setStdIn($fh);
+if (!$command->execute()) {
+    echo $command->getError();
+} else {
+    echo $command->getOutput();
+}
+fclose($fh);
+```
+From URL:
+```php
+<?php
+$fh = fopen('https://api.open-meteo.com/v1/forecast?latitude=52.52&longitude=13.41&hourly=temperature_2m,relativehumidity_2m,windspeed_10m', 'r');
+// error checks left out...
+$command = new Command('jq');
+$command->setStdIn($fh);
+if (!$command->execute()) {
+    echo $command->getError();
+} else {
+    echo $command->getOutput();
+}
+fclose($fh);
+```
+
+#### Set Command Instance Options
+```php
+<?php
 // Create command with options array
 $command = new Command(array(
     'command' => '/usr/local/bin/mycommand',
@@ -64,17 +128,6 @@ $command = new Command(array(
         'bypass_shell' => true,
     ),
 ));
-
-// Add arguments with correct escaping:
-// results in --name='d'\''Artagnan'
-$command->addArg('--name=', "d'Artagnan");
-
-// Add argument with several values
-// results in --keys key1 key2
-$command->addArg('--keys', array('key1','key2'));
-
-// Add string to pipe to command on standard input
-$command->setStdIn('string');
 ```
 
 ## API