Update documentation

Author: Riimu

README.md

@@ -28,43 +28,47 @@ The API documentation is available at: http://violet.riimu.net/api/streaming-jso
 
 ## Requirements ##
 
-In order to use this library, the following requirements must be met:
-
-  * PHP version 5.6, 7.0 or later
-  * The PHP library `psr/http-message` must be available
+  * The minimum supported PHP version is 5.6
+  * The library depends on the following external PHP libraries:
+    * [psr/http-message](https://packagist.org/packages/psr/http-message) (`^1.0`)
 
 ## Installation ##
 
+### Installation with Composer ###
+
 The easiest way to install this library is to use Composer to handle your
 dependencies. In order to install this library via Composer, simply follow
-the following two steps:
+these two steps:
 
-  1. Acquire the `composer.phar` by running the Composer [Command-line
-     installation script](https://getcomposer.org/download/) in your project
-     root.
-  2. Once you've run the installation script, you should have a `composer.phar` 
+  1. Acquire the `composer.phar` by running the Composer
+     [Command-line installation script](https://getcomposer.org/download/)
+     in your project root.
+
+  2. Once you have run the installation script, you should have the `composer.phar`
      file in you project root and you can run the following command:
-    
+
      ```
-     php composer.phar require "violet/streaming-json-encoder:^1.0"
+     php composer.phar require "violet/streaming-json-encoder:^1.1"
      ```
+
+After installing this library via Composer, you can load the library by
+including the `vendor/autoload.php` file that was generated by Composer during
+the installation.
+
+### Adding the library as a dependency ###
     
-If you are already familiar with how to use Composer, you may also alternatively
-simply add the library as a dependency by adding the following `composer.json`
-file to your project and running the `composer install` command:
+If you are already familiar with how to use Composer, you may alternatively add
+the library as a dependency by adding the following `composer.json` file to your
+project and running the `composer install` command:
 
 ```json
 {
     "require": {
-        "violet/streaming-json-encoder": "^1.0"
+        "violet/streaming-json-encoder": "^1.1"
     }
 }
 ```
 
-After installing this library via Composer, you can load the library by
-including the `vendor/autoload.php` file that was generated by Composer during
-the installation.
-
 ### Manual installation ###
 
 If you do not wish to use Composer to load the library, you may also download
@@ -73,8 +77,8 @@ and extracting the `src` folder to your project. You may then include the
 provided `src/autoload.php` file to load the library classes.
 
 Please note that using Composer will also automatically download the other
-required PHP libraries. If you install this library manually, you will need to
-also make those other required libraries available. 
+required PHP libraries. If you install this library manually, you will also need
+to make those other required libraries available.
 
 ## Usage ##
 
@@ -171,7 +175,7 @@ write the JSON to file in a streaming manner. For example:
 
 require 'vendor/autoload.php';
 
-$fp = fopen('test.json', 'w');
+$fp = fopen('test.json', 'wb');
 $encoder = new \Violet\StreamingJsonEncoder\StreamJsonEncoder(
     range(1, 100),
     function ($json) use ($fp) {

examples/benchmark.php

@@ -1,6 +1,6 @@
 <?php
 
-require __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';
 
 ini_set('memory_limit', '2048M');
 

examples/buffer_foreach.php

@@ -1,6 +1,6 @@
 <?php
 
-require '../vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';
 
 $encoder = new \Violet\StreamingJsonEncoder\BufferJsonEncoder(range(0, 10));
 

examples/buffer_generator.php

@@ -1,6 +1,6 @@
 <?php
 
-require '../vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';
 
 $encoder = new \Violet\StreamingJsonEncoder\BufferJsonEncoder(function () {
     for ($i = 0; $i <= 10; $i++) {

examples/buffer_simple.php

@@ -1,6 +1,6 @@
 <?php
 
-require '../vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';
 
 $encoder = new \Violet\StreamingJsonEncoder\BufferJsonEncoder(['array_value']);
 echo $encoder->encode();

examples/json_stream.php

@@ -1,6 +1,6 @@
 <?php
 
-require '../vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';
 
 $iterator = function () {
     foreach (new DirectoryIterator(__DIR__) as $file) {

examples/stream_file.php

@@ -1,8 +1,8 @@
 <?php
 
-require '../vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';
 
-$fp = fopen('test.json', 'w');
+$fp = fopen('test.json', 'wb');
 $encoder = new \Violet\StreamingJsonEncoder\StreamJsonEncoder(
     range(1, 100),
     function ($json) use ($fp) {

examples/stream_simple.php

@@ -1,6 +1,6 @@
 <?php
 
-require '../vendor/autoload.php';
+require_once __DIR__ . '/../vendor/autoload.php';
 
 $encoder = new \Violet\StreamingJsonEncoder\StreamJsonEncoder(['array_value']);
 $encoder->encode();